@googleapis/dns 16.0.0 → 17.1.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/CHANGELOG.md +18 -0
- package/build/index.js +0 -1
- package/build/index.js.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +1177 -18
- package/build/v1.js +375 -0
- package/build/v1.js.map +1 -1
- package/build/v1beta2.d.ts +6 -15
- package/build/v1beta2.js.map +1 -1
- package/index.ts +0 -1
- package/package.json +2 -2
- package/tsconfig.build.json +10 -0
- package/v1.ts +2687 -671
- package/v1beta2.ts +6 -15
package/build/v1.d.ts
CHANGED
|
@@ -69,8 +69,11 @@ export declare namespace dns_v1 {
|
|
|
69
69
|
context: APIRequestContext;
|
|
70
70
|
changes: Resource$Changes;
|
|
71
71
|
dnsKeys: Resource$Dnskeys;
|
|
72
|
+
locations: Resource$Locations;
|
|
72
73
|
managedZoneOperations: Resource$Managedzoneoperations;
|
|
73
74
|
managedZones: Resource$Managedzones;
|
|
75
|
+
operations: Resource$Operations;
|
|
76
|
+
outboundEndpoints: Resource$Outboundendpoints;
|
|
74
77
|
policies: Resource$Policies;
|
|
75
78
|
projects: Resource$Projects;
|
|
76
79
|
resourceRecordSets: Resource$Resourcerecordsets;
|
|
@@ -117,7 +120,7 @@ export declare namespace dns_v1 {
|
|
|
117
120
|
*/
|
|
118
121
|
changes?: Schema$Change[];
|
|
119
122
|
/**
|
|
120
|
-
* Type of resource.
|
|
123
|
+
* Output only. Type of resource.
|
|
121
124
|
*/
|
|
122
125
|
kind?: string | null;
|
|
123
126
|
/**
|
|
@@ -190,7 +193,7 @@ export declare namespace dns_v1 {
|
|
|
190
193
|
*/
|
|
191
194
|
dnsKeys?: Schema$DnsKey[];
|
|
192
195
|
/**
|
|
193
|
-
* Type of resource.
|
|
196
|
+
* Output only. Type of resource.
|
|
194
197
|
*/
|
|
195
198
|
kind?: string | null;
|
|
196
199
|
/**
|
|
@@ -216,6 +219,11 @@ export declare namespace dns_v1 {
|
|
|
216
219
|
keyType?: string | null;
|
|
217
220
|
kind?: string | null;
|
|
218
221
|
}
|
|
222
|
+
/**
|
|
223
|
+
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
|
|
224
|
+
*/
|
|
225
|
+
export interface Schema$Empty {
|
|
226
|
+
}
|
|
219
227
|
/**
|
|
220
228
|
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
|
|
221
229
|
*/
|
|
@@ -350,6 +358,23 @@ export declare namespace dns_v1 {
|
|
|
350
358
|
*/
|
|
351
359
|
permissions?: string[] | null;
|
|
352
360
|
}
|
|
361
|
+
/**
|
|
362
|
+
* The response message for Operations.ListOperations.
|
|
363
|
+
*/
|
|
364
|
+
export interface Schema$GoogleLongrunningListOperationsResponse {
|
|
365
|
+
/**
|
|
366
|
+
* The standard List next-page token.
|
|
367
|
+
*/
|
|
368
|
+
nextPageToken?: string | null;
|
|
369
|
+
/**
|
|
370
|
+
* A list of operations that matches the specified filter in the request.
|
|
371
|
+
*/
|
|
372
|
+
operations?: Schema$GoogleLongrunningOperation[];
|
|
373
|
+
/**
|
|
374
|
+
* Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
|
|
375
|
+
*/
|
|
376
|
+
unreachable?: string[] | null;
|
|
377
|
+
}
|
|
353
378
|
/**
|
|
354
379
|
* This resource represents a long-running operation that is the result of a network API call.
|
|
355
380
|
*/
|
|
@@ -379,6 +404,65 @@ export declare namespace dns_v1 {
|
|
|
379
404
|
[key: string]: any;
|
|
380
405
|
} | null;
|
|
381
406
|
}
|
|
407
|
+
/**
|
|
408
|
+
* The response message for Locations.ListLocations.
|
|
409
|
+
*/
|
|
410
|
+
export interface Schema$ListLocationsResponse {
|
|
411
|
+
/**
|
|
412
|
+
* A list of locations that matches the specified filter in the request.
|
|
413
|
+
*/
|
|
414
|
+
locations?: Schema$Location[];
|
|
415
|
+
/**
|
|
416
|
+
* The standard List next-page token.
|
|
417
|
+
*/
|
|
418
|
+
nextPageToken?: string | null;
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* Response message for OutboundEndpointsService.ListOutboundEndpoints
|
|
422
|
+
*/
|
|
423
|
+
export interface Schema$ListOutboundEndpointsResponse {
|
|
424
|
+
/**
|
|
425
|
+
* A token to retrieve the next page of results. Set to empty if there are no remaining results.
|
|
426
|
+
*/
|
|
427
|
+
nextPageToken?: string | null;
|
|
428
|
+
/**
|
|
429
|
+
* The list of OutboundEndpoints.
|
|
430
|
+
*/
|
|
431
|
+
outboundEndpoints?: Schema$OutboundEndpoint[];
|
|
432
|
+
/**
|
|
433
|
+
* Unordered list. The resource names of the unreachable locations. Format: `projects/{project\}/locations/{location\}`
|
|
434
|
+
*/
|
|
435
|
+
unreachable?: string[] | null;
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
* A resource that represents a Google Cloud location.
|
|
439
|
+
*/
|
|
440
|
+
export interface Schema$Location {
|
|
441
|
+
/**
|
|
442
|
+
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
|
|
443
|
+
*/
|
|
444
|
+
displayName?: string | null;
|
|
445
|
+
/**
|
|
446
|
+
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
|
|
447
|
+
*/
|
|
448
|
+
labels?: {
|
|
449
|
+
[key: string]: string;
|
|
450
|
+
} | null;
|
|
451
|
+
/**
|
|
452
|
+
* The canonical id for this location. For example: `"us-east1"`.
|
|
453
|
+
*/
|
|
454
|
+
locationId?: string | null;
|
|
455
|
+
/**
|
|
456
|
+
* Service-specific metadata. For example the available capacity at the given location.
|
|
457
|
+
*/
|
|
458
|
+
metadata?: {
|
|
459
|
+
[key: string]: any;
|
|
460
|
+
} | null;
|
|
461
|
+
/**
|
|
462
|
+
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
|
|
463
|
+
*/
|
|
464
|
+
name?: string | null;
|
|
465
|
+
}
|
|
382
466
|
/**
|
|
383
467
|
* A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
|
|
384
468
|
*/
|
|
@@ -475,6 +559,10 @@ export declare namespace dns_v1 {
|
|
|
475
559
|
}
|
|
476
560
|
export interface Schema$ManagedZoneForwardingConfig {
|
|
477
561
|
kind?: string | null;
|
|
562
|
+
/**
|
|
563
|
+
* The list of outbound endpoints to use for queries.
|
|
564
|
+
*/
|
|
565
|
+
outboundEndpoints?: Schema$ManagedZoneForwardingConfigOutboundEndpoint[];
|
|
478
566
|
/**
|
|
479
567
|
* List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
|
|
480
568
|
*/
|
|
@@ -499,9 +587,16 @@ export declare namespace dns_v1 {
|
|
|
499
587
|
ipv6Address?: string | null;
|
|
500
588
|
kind?: string | null;
|
|
501
589
|
}
|
|
590
|
+
export interface Schema$ManagedZoneForwardingConfigOutboundEndpoint {
|
|
591
|
+
kind?: string | null;
|
|
592
|
+
/**
|
|
593
|
+
* Specified as a resource path including project and region. This should be formatted like projects/{project\}/locations/{location\}/outboundEndpoints/{endpoint\}
|
|
594
|
+
*/
|
|
595
|
+
name?: string | null;
|
|
596
|
+
}
|
|
502
597
|
export interface Schema$ManagedZoneOperationsListResponse {
|
|
503
598
|
/**
|
|
504
|
-
* Type of resource.
|
|
599
|
+
* Output only. Type of resource.
|
|
505
600
|
*/
|
|
506
601
|
kind?: string | null;
|
|
507
602
|
/**
|
|
@@ -582,7 +677,7 @@ export declare namespace dns_v1 {
|
|
|
582
677
|
}
|
|
583
678
|
export interface Schema$ManagedZonesListResponse {
|
|
584
679
|
/**
|
|
585
|
-
* Type of resource.
|
|
680
|
+
* Output only. Type of resource.
|
|
586
681
|
*/
|
|
587
682
|
kind?: string | null;
|
|
588
683
|
/**
|
|
@@ -648,9 +743,93 @@ export declare namespace dns_v1 {
|
|
|
648
743
|
*/
|
|
649
744
|
oldValue?: Schema$ManagedZone;
|
|
650
745
|
}
|
|
746
|
+
/**
|
|
747
|
+
* Represents the metadata of the long-running operation.
|
|
748
|
+
*/
|
|
749
|
+
export interface Schema$OperationMetadata {
|
|
750
|
+
/**
|
|
751
|
+
* Output only. API version used to start the operation.
|
|
752
|
+
*/
|
|
753
|
+
apiVersion?: string | null;
|
|
754
|
+
/**
|
|
755
|
+
* Output only. The time the operation was created.
|
|
756
|
+
*/
|
|
757
|
+
createTime?: string | null;
|
|
758
|
+
/**
|
|
759
|
+
* Output only. The time the operation finished running.
|
|
760
|
+
*/
|
|
761
|
+
endTime?: string | null;
|
|
762
|
+
/**
|
|
763
|
+
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
764
|
+
*/
|
|
765
|
+
requestedCancellation?: boolean | null;
|
|
766
|
+
/**
|
|
767
|
+
* Output only. Human-readable status of the operation, if any.
|
|
768
|
+
*/
|
|
769
|
+
statusMessage?: string | null;
|
|
770
|
+
/**
|
|
771
|
+
* Output only. Server-defined resource path for the target of the operation.
|
|
772
|
+
*/
|
|
773
|
+
target?: string | null;
|
|
774
|
+
/**
|
|
775
|
+
* Output only. Name of the verb executed by the operation.
|
|
776
|
+
*/
|
|
777
|
+
verb?: string | null;
|
|
778
|
+
}
|
|
779
|
+
/**
|
|
780
|
+
* An OutboundEndpoint is a regional resource to enable outbound forwarding from a private IP range in VPCs to on-premise or other networks.
|
|
781
|
+
*/
|
|
782
|
+
export interface Schema$OutboundEndpoint {
|
|
783
|
+
/**
|
|
784
|
+
* Optional. Annotations as key value pairs
|
|
785
|
+
*/
|
|
786
|
+
annotations?: {
|
|
787
|
+
[key: string]: string;
|
|
788
|
+
} | null;
|
|
789
|
+
/**
|
|
790
|
+
* Output only. [Output only] Create time stamp
|
|
791
|
+
*/
|
|
792
|
+
createTime?: string | null;
|
|
793
|
+
/**
|
|
794
|
+
* Optional. User provided description.
|
|
795
|
+
*/
|
|
796
|
+
description?: string | null;
|
|
797
|
+
/**
|
|
798
|
+
* Required. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork.
|
|
799
|
+
*/
|
|
800
|
+
endpointIp?: string | null;
|
|
801
|
+
/**
|
|
802
|
+
* Optional. Labels as key value pairs
|
|
803
|
+
*/
|
|
804
|
+
labels?: {
|
|
805
|
+
[key: string]: string;
|
|
806
|
+
} | null;
|
|
807
|
+
/**
|
|
808
|
+
* Identifier. The resource name of the OutboundEndpoint. Format: `projects/{project\}/locations/{location\}/outboundEndpoints/{outboundEndpoint\}`
|
|
809
|
+
*/
|
|
810
|
+
name?: string | null;
|
|
811
|
+
/**
|
|
812
|
+
* Required. Immutable. The VPC network containing the outbound endpoint, specified as full path.
|
|
813
|
+
*/
|
|
814
|
+
network?: string | null;
|
|
815
|
+
/**
|
|
816
|
+
* Required. Immutable. The subnetwork holding the endpoint_ip, specified as full path.
|
|
817
|
+
*/
|
|
818
|
+
subnetwork?: string | null;
|
|
819
|
+
/**
|
|
820
|
+
* Optional. Tag bindings as key value pairs
|
|
821
|
+
*/
|
|
822
|
+
tags?: {
|
|
823
|
+
[key: string]: string;
|
|
824
|
+
} | null;
|
|
825
|
+
/**
|
|
826
|
+
* Output only. [Output only] Update time stamp
|
|
827
|
+
*/
|
|
828
|
+
updateTime?: string | null;
|
|
829
|
+
}
|
|
651
830
|
export interface Schema$PoliciesListResponse {
|
|
652
831
|
/**
|
|
653
|
-
* Type of resource.
|
|
832
|
+
* Output only. Type of resource.
|
|
654
833
|
*/
|
|
655
834
|
kind?: string | null;
|
|
656
835
|
/**
|
|
@@ -708,11 +887,22 @@ export declare namespace dns_v1 {
|
|
|
708
887
|
}
|
|
709
888
|
export interface Schema$PolicyAlternativeNameServerConfig {
|
|
710
889
|
kind?: string | null;
|
|
890
|
+
/**
|
|
891
|
+
* The list of outbound endpoints to use for queries.
|
|
892
|
+
*/
|
|
893
|
+
outboundEndpoints?: Schema$PolicyAlternativeNameServerConfigOutboundEndpoint[];
|
|
711
894
|
/**
|
|
712
895
|
* Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
|
|
713
896
|
*/
|
|
714
897
|
targetNameServers?: Schema$PolicyAlternativeNameServerConfigTargetNameServer[];
|
|
715
898
|
}
|
|
899
|
+
export interface Schema$PolicyAlternativeNameServerConfigOutboundEndpoint {
|
|
900
|
+
kind?: string | null;
|
|
901
|
+
/**
|
|
902
|
+
* Specified as a resource path including project and region. This should be formatted like projects/{project\}/locations/{location\}/outboundEndpoints/{endpoint\}
|
|
903
|
+
*/
|
|
904
|
+
name?: string | null;
|
|
905
|
+
}
|
|
716
906
|
export interface Schema$PolicyAlternativeNameServerConfigTargetNameServer {
|
|
717
907
|
/**
|
|
718
908
|
* Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
|
|
@@ -824,6 +1014,14 @@ export declare namespace dns_v1 {
|
|
|
824
1014
|
* Maximum allowed number of networks per response policy.
|
|
825
1015
|
*/
|
|
826
1016
|
networksPerResponsePolicy?: number | null;
|
|
1017
|
+
/**
|
|
1018
|
+
* Maximum allowed number of outbound endpoints per managed zone.
|
|
1019
|
+
*/
|
|
1020
|
+
outboundEndpointsPerManagedZone?: number | null;
|
|
1021
|
+
/**
|
|
1022
|
+
* Maximum allowed number of outbound endpoints per policy.
|
|
1023
|
+
*/
|
|
1024
|
+
outboundEndpointsPerPolicy?: number | null;
|
|
827
1025
|
/**
|
|
828
1026
|
* Maximum allowed number of consumer peering zones per target network owned by this producer project
|
|
829
1027
|
*/
|
|
@@ -890,9 +1088,6 @@ export declare namespace dns_v1 {
|
|
|
890
1088
|
* As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
|
|
891
1089
|
*/
|
|
892
1090
|
rrdatas?: string[] | null;
|
|
893
|
-
/**
|
|
894
|
-
* As defined in RFC 4034 (section 3.2).
|
|
895
|
-
*/
|
|
896
1091
|
signatureRrdatas?: string[] | null;
|
|
897
1092
|
/**
|
|
898
1093
|
* Number of seconds that this `ResourceRecordSet` can be cached by resolvers.
|
|
@@ -907,7 +1102,7 @@ export declare namespace dns_v1 {
|
|
|
907
1102
|
}
|
|
908
1103
|
export interface Schema$ResourceRecordSetsListResponse {
|
|
909
1104
|
/**
|
|
910
|
-
* Type of resource.
|
|
1105
|
+
* Output only. Type of resource.
|
|
911
1106
|
*/
|
|
912
1107
|
kind?: string | null;
|
|
913
1108
|
/**
|
|
@@ -1694,6 +1889,181 @@ export declare namespace dns_v1 {
|
|
|
1694
1889
|
*/
|
|
1695
1890
|
project?: string;
|
|
1696
1891
|
}
|
|
1892
|
+
export class Resource$Locations {
|
|
1893
|
+
context: APIRequestContext;
|
|
1894
|
+
constructor(context: APIRequestContext);
|
|
1895
|
+
/**
|
|
1896
|
+
* Gets information about a location.
|
|
1897
|
+
* @example
|
|
1898
|
+
* ```js
|
|
1899
|
+
* // Before running the sample:
|
|
1900
|
+
* // - Enable the API at:
|
|
1901
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
1902
|
+
* // - Login into gcloud by running:
|
|
1903
|
+
* // ```sh
|
|
1904
|
+
* // $ gcloud auth application-default login
|
|
1905
|
+
* // ```
|
|
1906
|
+
* // - Install the npm module by running:
|
|
1907
|
+
* // ```sh
|
|
1908
|
+
* // $ npm install googleapis
|
|
1909
|
+
* // ```
|
|
1910
|
+
*
|
|
1911
|
+
* const {google} = require('googleapis');
|
|
1912
|
+
* const dns = google.dns('v1');
|
|
1913
|
+
*
|
|
1914
|
+
* async function main() {
|
|
1915
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1916
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1917
|
+
* scopes: [
|
|
1918
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1919
|
+
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
1920
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
|
|
1921
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
1922
|
+
* ],
|
|
1923
|
+
* });
|
|
1924
|
+
*
|
|
1925
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1926
|
+
* const authClient = await auth.getClient();
|
|
1927
|
+
* google.options({auth: authClient});
|
|
1928
|
+
*
|
|
1929
|
+
* // Do the magic
|
|
1930
|
+
* const res = await dns.locations.get({
|
|
1931
|
+
* // Resource name for the location.
|
|
1932
|
+
* name: 'projects/my-project/locations/my-location',
|
|
1933
|
+
* });
|
|
1934
|
+
* console.log(res.data);
|
|
1935
|
+
*
|
|
1936
|
+
* // Example response
|
|
1937
|
+
* // {
|
|
1938
|
+
* // "displayName": "my_displayName",
|
|
1939
|
+
* // "labels": {},
|
|
1940
|
+
* // "locationId": "my_locationId",
|
|
1941
|
+
* // "metadata": {},
|
|
1942
|
+
* // "name": "my_name"
|
|
1943
|
+
* // }
|
|
1944
|
+
* }
|
|
1945
|
+
*
|
|
1946
|
+
* main().catch(e => {
|
|
1947
|
+
* console.error(e);
|
|
1948
|
+
* throw e;
|
|
1949
|
+
* });
|
|
1950
|
+
*
|
|
1951
|
+
* ```
|
|
1952
|
+
*
|
|
1953
|
+
* @param params - Parameters for request
|
|
1954
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
1955
|
+
* @param callback - Optional callback that handles the response.
|
|
1956
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
1957
|
+
*/
|
|
1958
|
+
get(params: Params$Resource$Locations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
1959
|
+
get(params?: Params$Resource$Locations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Location>>;
|
|
1960
|
+
get(params: Params$Resource$Locations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
1961
|
+
get(params: Params$Resource$Locations$Get, options: MethodOptions | BodyResponseCallback<Schema$Location>, callback: BodyResponseCallback<Schema$Location>): void;
|
|
1962
|
+
get(params: Params$Resource$Locations$Get, callback: BodyResponseCallback<Schema$Location>): void;
|
|
1963
|
+
get(callback: BodyResponseCallback<Schema$Location>): void;
|
|
1964
|
+
/**
|
|
1965
|
+
* Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
|
|
1966
|
+
* @example
|
|
1967
|
+
* ```js
|
|
1968
|
+
* // Before running the sample:
|
|
1969
|
+
* // - Enable the API at:
|
|
1970
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
1971
|
+
* // - Login into gcloud by running:
|
|
1972
|
+
* // ```sh
|
|
1973
|
+
* // $ gcloud auth application-default login
|
|
1974
|
+
* // ```
|
|
1975
|
+
* // - Install the npm module by running:
|
|
1976
|
+
* // ```sh
|
|
1977
|
+
* // $ npm install googleapis
|
|
1978
|
+
* // ```
|
|
1979
|
+
*
|
|
1980
|
+
* const {google} = require('googleapis');
|
|
1981
|
+
* const dns = google.dns('v1');
|
|
1982
|
+
*
|
|
1983
|
+
* async function main() {
|
|
1984
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1985
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1986
|
+
* scopes: [
|
|
1987
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1988
|
+
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
1989
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
|
|
1990
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
1991
|
+
* ],
|
|
1992
|
+
* });
|
|
1993
|
+
*
|
|
1994
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1995
|
+
* const authClient = await auth.getClient();
|
|
1996
|
+
* google.options({auth: authClient});
|
|
1997
|
+
*
|
|
1998
|
+
* // Do the magic
|
|
1999
|
+
* const res = await dns.locations.list({
|
|
2000
|
+
* // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
2001
|
+
* extraLocationTypes: 'placeholder-value',
|
|
2002
|
+
* // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
|
|
2003
|
+
* filter: 'placeholder-value',
|
|
2004
|
+
* // The resource that owns the locations collection, if applicable.
|
|
2005
|
+
* name: 'projects/my-project',
|
|
2006
|
+
* // The maximum number of results to return. If not set, the service selects a default.
|
|
2007
|
+
* pageSize: 'placeholder-value',
|
|
2008
|
+
* // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
|
|
2009
|
+
* pageToken: 'placeholder-value',
|
|
2010
|
+
* });
|
|
2011
|
+
* console.log(res.data);
|
|
2012
|
+
*
|
|
2013
|
+
* // Example response
|
|
2014
|
+
* // {
|
|
2015
|
+
* // "locations": [],
|
|
2016
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
2017
|
+
* // }
|
|
2018
|
+
* }
|
|
2019
|
+
*
|
|
2020
|
+
* main().catch(e => {
|
|
2021
|
+
* console.error(e);
|
|
2022
|
+
* throw e;
|
|
2023
|
+
* });
|
|
2024
|
+
*
|
|
2025
|
+
* ```
|
|
2026
|
+
*
|
|
2027
|
+
* @param params - Parameters for request
|
|
2028
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2029
|
+
* @param callback - Optional callback that handles the response.
|
|
2030
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2031
|
+
*/
|
|
2032
|
+
list(params: Params$Resource$Locations$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2033
|
+
list(params?: Params$Resource$Locations$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListLocationsResponse>>;
|
|
2034
|
+
list(params: Params$Resource$Locations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2035
|
+
list(params: Params$Resource$Locations$List, options: MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
|
|
2036
|
+
list(params: Params$Resource$Locations$List, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
|
|
2037
|
+
list(callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
|
|
2038
|
+
}
|
|
2039
|
+
export interface Params$Resource$Locations$Get extends StandardParameters {
|
|
2040
|
+
/**
|
|
2041
|
+
* Resource name for the location.
|
|
2042
|
+
*/
|
|
2043
|
+
name?: string;
|
|
2044
|
+
}
|
|
2045
|
+
export interface Params$Resource$Locations$List extends StandardParameters {
|
|
2046
|
+
/**
|
|
2047
|
+
* Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
2048
|
+
*/
|
|
2049
|
+
extraLocationTypes?: string[];
|
|
2050
|
+
/**
|
|
2051
|
+
* A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
|
|
2052
|
+
*/
|
|
2053
|
+
filter?: string;
|
|
2054
|
+
/**
|
|
2055
|
+
* The resource that owns the locations collection, if applicable.
|
|
2056
|
+
*/
|
|
2057
|
+
name?: string;
|
|
2058
|
+
/**
|
|
2059
|
+
* The maximum number of results to return. If not set, the service selects a default.
|
|
2060
|
+
*/
|
|
2061
|
+
pageSize?: number;
|
|
2062
|
+
/**
|
|
2063
|
+
* A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
|
|
2064
|
+
*/
|
|
2065
|
+
pageToken?: string;
|
|
2066
|
+
}
|
|
1697
2067
|
export class Resource$Managedzoneoperations {
|
|
1698
2068
|
context: APIRequestContext;
|
|
1699
2069
|
constructor(context: APIRequestContext);
|
|
@@ -2766,11 +3136,11 @@ export declare namespace dns_v1 {
|
|
|
2766
3136
|
*/
|
|
2767
3137
|
requestBody?: Schema$ManagedZone;
|
|
2768
3138
|
}
|
|
2769
|
-
export class Resource$
|
|
3139
|
+
export class Resource$Operations {
|
|
2770
3140
|
context: APIRequestContext;
|
|
2771
3141
|
constructor(context: APIRequestContext);
|
|
2772
3142
|
/**
|
|
2773
|
-
*
|
|
3143
|
+
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
|
|
2774
3144
|
* @example
|
|
2775
3145
|
* ```js
|
|
2776
3146
|
* // Before running the sample:
|
|
@@ -2802,7 +3172,802 @@ export declare namespace dns_v1 {
|
|
|
2802
3172
|
* google.options({auth: authClient});
|
|
2803
3173
|
*
|
|
2804
3174
|
* // Do the magic
|
|
2805
|
-
* const res = await dns.
|
|
3175
|
+
* const res = await dns.operations.cancel({
|
|
3176
|
+
* // The name of the operation resource to be cancelled.
|
|
3177
|
+
* name: 'projects/my-project/locations/my-location/operations/my-operation',
|
|
3178
|
+
* });
|
|
3179
|
+
* console.log(res.data);
|
|
3180
|
+
*
|
|
3181
|
+
* // Example response
|
|
3182
|
+
* // {}
|
|
3183
|
+
* }
|
|
3184
|
+
*
|
|
3185
|
+
* main().catch(e => {
|
|
3186
|
+
* console.error(e);
|
|
3187
|
+
* throw e;
|
|
3188
|
+
* });
|
|
3189
|
+
*
|
|
3190
|
+
* ```
|
|
3191
|
+
*
|
|
3192
|
+
* @param params - Parameters for request
|
|
3193
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3194
|
+
* @param callback - Optional callback that handles the response.
|
|
3195
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3196
|
+
*/
|
|
3197
|
+
cancel(params: Params$Resource$Operations$Cancel, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3198
|
+
cancel(params?: Params$Resource$Operations$Cancel, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
|
|
3199
|
+
cancel(params: Params$Resource$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3200
|
+
cancel(params: Params$Resource$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3201
|
+
cancel(params: Params$Resource$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3202
|
+
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3203
|
+
/**
|
|
3204
|
+
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
3205
|
+
* @example
|
|
3206
|
+
* ```js
|
|
3207
|
+
* // Before running the sample:
|
|
3208
|
+
* // - Enable the API at:
|
|
3209
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
3210
|
+
* // - Login into gcloud by running:
|
|
3211
|
+
* // ```sh
|
|
3212
|
+
* // $ gcloud auth application-default login
|
|
3213
|
+
* // ```
|
|
3214
|
+
* // - Install the npm module by running:
|
|
3215
|
+
* // ```sh
|
|
3216
|
+
* // $ npm install googleapis
|
|
3217
|
+
* // ```
|
|
3218
|
+
*
|
|
3219
|
+
* const {google} = require('googleapis');
|
|
3220
|
+
* const dns = google.dns('v1');
|
|
3221
|
+
*
|
|
3222
|
+
* async function main() {
|
|
3223
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3224
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3225
|
+
* scopes: [
|
|
3226
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3227
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
3228
|
+
* ],
|
|
3229
|
+
* });
|
|
3230
|
+
*
|
|
3231
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3232
|
+
* const authClient = await auth.getClient();
|
|
3233
|
+
* google.options({auth: authClient});
|
|
3234
|
+
*
|
|
3235
|
+
* // Do the magic
|
|
3236
|
+
* const res = await dns.operations.delete({
|
|
3237
|
+
* // The name of the operation resource to be deleted.
|
|
3238
|
+
* name: 'projects/my-project/locations/my-location/operations/my-operation',
|
|
3239
|
+
* });
|
|
3240
|
+
* console.log(res.data);
|
|
3241
|
+
*
|
|
3242
|
+
* // Example response
|
|
3243
|
+
* // {}
|
|
3244
|
+
* }
|
|
3245
|
+
*
|
|
3246
|
+
* main().catch(e => {
|
|
3247
|
+
* console.error(e);
|
|
3248
|
+
* throw e;
|
|
3249
|
+
* });
|
|
3250
|
+
*
|
|
3251
|
+
* ```
|
|
3252
|
+
*
|
|
3253
|
+
* @param params - Parameters for request
|
|
3254
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3255
|
+
* @param callback - Optional callback that handles the response.
|
|
3256
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3257
|
+
*/
|
|
3258
|
+
delete(params: Params$Resource$Operations$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3259
|
+
delete(params?: Params$Resource$Operations$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
|
|
3260
|
+
delete(params: Params$Resource$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3261
|
+
delete(params: Params$Resource$Operations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3262
|
+
delete(params: Params$Resource$Operations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3263
|
+
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3264
|
+
/**
|
|
3265
|
+
* 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.
|
|
3266
|
+
* @example
|
|
3267
|
+
* ```js
|
|
3268
|
+
* // Before running the sample:
|
|
3269
|
+
* // - Enable the API at:
|
|
3270
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
3271
|
+
* // - Login into gcloud by running:
|
|
3272
|
+
* // ```sh
|
|
3273
|
+
* // $ gcloud auth application-default login
|
|
3274
|
+
* // ```
|
|
3275
|
+
* // - Install the npm module by running:
|
|
3276
|
+
* // ```sh
|
|
3277
|
+
* // $ npm install googleapis
|
|
3278
|
+
* // ```
|
|
3279
|
+
*
|
|
3280
|
+
* const {google} = require('googleapis');
|
|
3281
|
+
* const dns = google.dns('v1');
|
|
3282
|
+
*
|
|
3283
|
+
* async function main() {
|
|
3284
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3285
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3286
|
+
* scopes: [
|
|
3287
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3288
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
3289
|
+
* ],
|
|
3290
|
+
* });
|
|
3291
|
+
*
|
|
3292
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3293
|
+
* const authClient = await auth.getClient();
|
|
3294
|
+
* google.options({auth: authClient});
|
|
3295
|
+
*
|
|
3296
|
+
* // Do the magic
|
|
3297
|
+
* const res = await dns.operations.get({
|
|
3298
|
+
* // The name of the operation resource.
|
|
3299
|
+
* name: 'projects/my-project/locations/my-location/operations/my-operation',
|
|
3300
|
+
* });
|
|
3301
|
+
* console.log(res.data);
|
|
3302
|
+
*
|
|
3303
|
+
* // Example response
|
|
3304
|
+
* // {
|
|
3305
|
+
* // "done": false,
|
|
3306
|
+
* // "error": {},
|
|
3307
|
+
* // "metadata": {},
|
|
3308
|
+
* // "name": "my_name",
|
|
3309
|
+
* // "response": {}
|
|
3310
|
+
* // }
|
|
3311
|
+
* }
|
|
3312
|
+
*
|
|
3313
|
+
* main().catch(e => {
|
|
3314
|
+
* console.error(e);
|
|
3315
|
+
* throw e;
|
|
3316
|
+
* });
|
|
3317
|
+
*
|
|
3318
|
+
* ```
|
|
3319
|
+
*
|
|
3320
|
+
* @param params - Parameters for request
|
|
3321
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3322
|
+
* @param callback - Optional callback that handles the response.
|
|
3323
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3324
|
+
*/
|
|
3325
|
+
get(params: Params$Resource$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3326
|
+
get(params?: Params$Resource$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
3327
|
+
get(params: Params$Resource$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3328
|
+
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3329
|
+
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3330
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3331
|
+
/**
|
|
3332
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
3333
|
+
* @example
|
|
3334
|
+
* ```js
|
|
3335
|
+
* // Before running the sample:
|
|
3336
|
+
* // - Enable the API at:
|
|
3337
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
3338
|
+
* // - Login into gcloud by running:
|
|
3339
|
+
* // ```sh
|
|
3340
|
+
* // $ gcloud auth application-default login
|
|
3341
|
+
* // ```
|
|
3342
|
+
* // - Install the npm module by running:
|
|
3343
|
+
* // ```sh
|
|
3344
|
+
* // $ npm install googleapis
|
|
3345
|
+
* // ```
|
|
3346
|
+
*
|
|
3347
|
+
* const {google} = require('googleapis');
|
|
3348
|
+
* const dns = google.dns('v1');
|
|
3349
|
+
*
|
|
3350
|
+
* async function main() {
|
|
3351
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3352
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3353
|
+
* scopes: [
|
|
3354
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3355
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
3356
|
+
* ],
|
|
3357
|
+
* });
|
|
3358
|
+
*
|
|
3359
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3360
|
+
* const authClient = await auth.getClient();
|
|
3361
|
+
* google.options({auth: authClient});
|
|
3362
|
+
*
|
|
3363
|
+
* // Do the magic
|
|
3364
|
+
* const res = await dns.operations.list({
|
|
3365
|
+
* // The standard list filter.
|
|
3366
|
+
* filter: 'placeholder-value',
|
|
3367
|
+
* // The name of the operation's parent resource.
|
|
3368
|
+
* name: 'projects/my-project/locations/my-location',
|
|
3369
|
+
* // The standard list page size.
|
|
3370
|
+
* pageSize: 'placeholder-value',
|
|
3371
|
+
* // The standard list page token.
|
|
3372
|
+
* pageToken: 'placeholder-value',
|
|
3373
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
3374
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
3375
|
+
* });
|
|
3376
|
+
* console.log(res.data);
|
|
3377
|
+
*
|
|
3378
|
+
* // Example response
|
|
3379
|
+
* // {
|
|
3380
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
3381
|
+
* // "operations": [],
|
|
3382
|
+
* // "unreachable": []
|
|
3383
|
+
* // }
|
|
3384
|
+
* }
|
|
3385
|
+
*
|
|
3386
|
+
* main().catch(e => {
|
|
3387
|
+
* console.error(e);
|
|
3388
|
+
* throw e;
|
|
3389
|
+
* });
|
|
3390
|
+
*
|
|
3391
|
+
* ```
|
|
3392
|
+
*
|
|
3393
|
+
* @param params - Parameters for request
|
|
3394
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3395
|
+
* @param callback - Optional callback that handles the response.
|
|
3396
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3397
|
+
*/
|
|
3398
|
+
list(params: Params$Resource$Operations$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3399
|
+
list(params?: Params$Resource$Operations$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningListOperationsResponse>>;
|
|
3400
|
+
list(params: Params$Resource$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3401
|
+
list(params: Params$Resource$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
3402
|
+
list(params: Params$Resource$Operations$List, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
3403
|
+
list(callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
3404
|
+
}
|
|
3405
|
+
export interface Params$Resource$Operations$Cancel extends StandardParameters {
|
|
3406
|
+
/**
|
|
3407
|
+
* The name of the operation resource to be cancelled.
|
|
3408
|
+
*/
|
|
3409
|
+
name?: string;
|
|
3410
|
+
}
|
|
3411
|
+
export interface Params$Resource$Operations$Delete extends StandardParameters {
|
|
3412
|
+
/**
|
|
3413
|
+
* The name of the operation resource to be deleted.
|
|
3414
|
+
*/
|
|
3415
|
+
name?: string;
|
|
3416
|
+
}
|
|
3417
|
+
export interface Params$Resource$Operations$Get extends StandardParameters {
|
|
3418
|
+
/**
|
|
3419
|
+
* The name of the operation resource.
|
|
3420
|
+
*/
|
|
3421
|
+
name?: string;
|
|
3422
|
+
}
|
|
3423
|
+
export interface Params$Resource$Operations$List extends StandardParameters {
|
|
3424
|
+
/**
|
|
3425
|
+
* The standard list filter.
|
|
3426
|
+
*/
|
|
3427
|
+
filter?: string;
|
|
3428
|
+
/**
|
|
3429
|
+
* The name of the operation's parent resource.
|
|
3430
|
+
*/
|
|
3431
|
+
name?: string;
|
|
3432
|
+
/**
|
|
3433
|
+
* The standard list page size.
|
|
3434
|
+
*/
|
|
3435
|
+
pageSize?: number;
|
|
3436
|
+
/**
|
|
3437
|
+
* The standard list page token.
|
|
3438
|
+
*/
|
|
3439
|
+
pageToken?: string;
|
|
3440
|
+
/**
|
|
3441
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
3442
|
+
*/
|
|
3443
|
+
returnPartialSuccess?: boolean;
|
|
3444
|
+
}
|
|
3445
|
+
export class Resource$Outboundendpoints {
|
|
3446
|
+
context: APIRequestContext;
|
|
3447
|
+
constructor(context: APIRequestContext);
|
|
3448
|
+
/**
|
|
3449
|
+
* Creates a new Outbound Endpoint.
|
|
3450
|
+
* @example
|
|
3451
|
+
* ```js
|
|
3452
|
+
* // Before running the sample:
|
|
3453
|
+
* // - Enable the API at:
|
|
3454
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
3455
|
+
* // - Login into gcloud by running:
|
|
3456
|
+
* // ```sh
|
|
3457
|
+
* // $ gcloud auth application-default login
|
|
3458
|
+
* // ```
|
|
3459
|
+
* // - Install the npm module by running:
|
|
3460
|
+
* // ```sh
|
|
3461
|
+
* // $ npm install googleapis
|
|
3462
|
+
* // ```
|
|
3463
|
+
*
|
|
3464
|
+
* const {google} = require('googleapis');
|
|
3465
|
+
* const dns = google.dns('v1');
|
|
3466
|
+
*
|
|
3467
|
+
* async function main() {
|
|
3468
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3469
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3470
|
+
* scopes: [
|
|
3471
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3472
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
3473
|
+
* ],
|
|
3474
|
+
* });
|
|
3475
|
+
*
|
|
3476
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3477
|
+
* const authClient = await auth.getClient();
|
|
3478
|
+
* google.options({auth: authClient});
|
|
3479
|
+
*
|
|
3480
|
+
* // Do the magic
|
|
3481
|
+
* const res = await dns.outboundEndpoints.create({
|
|
3482
|
+
* // For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
3483
|
+
* clientOperationId: 'placeholder-value',
|
|
3484
|
+
* // Required. The ID to use for the OutboundEndpoint, which will become the final component of the OutboundEndpoint's resource name.
|
|
3485
|
+
* outboundEndpointId: 'placeholder-value',
|
|
3486
|
+
* // Required. The parent project and location where this OutboundEndpoint will be created. Format: projects/{project\}/locations/{location\}
|
|
3487
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
3488
|
+
* // Optional. An optional request ID to identify requests.
|
|
3489
|
+
* requestId: 'placeholder-value',
|
|
3490
|
+
*
|
|
3491
|
+
* // Request body metadata
|
|
3492
|
+
* requestBody: {
|
|
3493
|
+
* // request body parameters
|
|
3494
|
+
* // {
|
|
3495
|
+
* // "annotations": {},
|
|
3496
|
+
* // "createTime": "my_createTime",
|
|
3497
|
+
* // "description": "my_description",
|
|
3498
|
+
* // "endpointIp": "my_endpointIp",
|
|
3499
|
+
* // "labels": {},
|
|
3500
|
+
* // "name": "my_name",
|
|
3501
|
+
* // "network": "my_network",
|
|
3502
|
+
* // "subnetwork": "my_subnetwork",
|
|
3503
|
+
* // "tags": {},
|
|
3504
|
+
* // "updateTime": "my_updateTime"
|
|
3505
|
+
* // }
|
|
3506
|
+
* },
|
|
3507
|
+
* });
|
|
3508
|
+
* console.log(res.data);
|
|
3509
|
+
*
|
|
3510
|
+
* // Example response
|
|
3511
|
+
* // {
|
|
3512
|
+
* // "done": false,
|
|
3513
|
+
* // "error": {},
|
|
3514
|
+
* // "metadata": {},
|
|
3515
|
+
* // "name": "my_name",
|
|
3516
|
+
* // "response": {}
|
|
3517
|
+
* // }
|
|
3518
|
+
* }
|
|
3519
|
+
*
|
|
3520
|
+
* main().catch(e => {
|
|
3521
|
+
* console.error(e);
|
|
3522
|
+
* throw e;
|
|
3523
|
+
* });
|
|
3524
|
+
*
|
|
3525
|
+
* ```
|
|
3526
|
+
*
|
|
3527
|
+
* @param params - Parameters for request
|
|
3528
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3529
|
+
* @param callback - Optional callback that handles the response.
|
|
3530
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3531
|
+
*/
|
|
3532
|
+
create(params: Params$Resource$Outboundendpoints$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3533
|
+
create(params?: Params$Resource$Outboundendpoints$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
3534
|
+
create(params: Params$Resource$Outboundendpoints$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3535
|
+
create(params: Params$Resource$Outboundendpoints$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3536
|
+
create(params: Params$Resource$Outboundendpoints$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3537
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3538
|
+
/**
|
|
3539
|
+
* Deletes a previously created Outbound Endpoint.
|
|
3540
|
+
* @example
|
|
3541
|
+
* ```js
|
|
3542
|
+
* // Before running the sample:
|
|
3543
|
+
* // - Enable the API at:
|
|
3544
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
3545
|
+
* // - Login into gcloud by running:
|
|
3546
|
+
* // ```sh
|
|
3547
|
+
* // $ gcloud auth application-default login
|
|
3548
|
+
* // ```
|
|
3549
|
+
* // - Install the npm module by running:
|
|
3550
|
+
* // ```sh
|
|
3551
|
+
* // $ npm install googleapis
|
|
3552
|
+
* // ```
|
|
3553
|
+
*
|
|
3554
|
+
* const {google} = require('googleapis');
|
|
3555
|
+
* const dns = google.dns('v1');
|
|
3556
|
+
*
|
|
3557
|
+
* async function main() {
|
|
3558
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3559
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3560
|
+
* scopes: [
|
|
3561
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3562
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
3563
|
+
* ],
|
|
3564
|
+
* });
|
|
3565
|
+
*
|
|
3566
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3567
|
+
* const authClient = await auth.getClient();
|
|
3568
|
+
* google.options({auth: authClient});
|
|
3569
|
+
*
|
|
3570
|
+
* // Do the magic
|
|
3571
|
+
* const res = await dns.outboundEndpoints.delete({
|
|
3572
|
+
* // For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
3573
|
+
* clientOperationId: 'placeholder-value',
|
|
3574
|
+
* // Required. The name of the OutboundEndpoint to delete. Format: projects/{project\}/locations/{location\}/outboundEndpoints/{outboundEndpoint\}
|
|
3575
|
+
* name: 'projects/my-project/locations/my-location/outboundEndpoints/my-outboundEndpoint',
|
|
3576
|
+
* // Optional. An optional request ID to identify requests.
|
|
3577
|
+
* requestId: 'placeholder-value',
|
|
3578
|
+
* });
|
|
3579
|
+
* console.log(res.data);
|
|
3580
|
+
*
|
|
3581
|
+
* // Example response
|
|
3582
|
+
* // {
|
|
3583
|
+
* // "done": false,
|
|
3584
|
+
* // "error": {},
|
|
3585
|
+
* // "metadata": {},
|
|
3586
|
+
* // "name": "my_name",
|
|
3587
|
+
* // "response": {}
|
|
3588
|
+
* // }
|
|
3589
|
+
* }
|
|
3590
|
+
*
|
|
3591
|
+
* main().catch(e => {
|
|
3592
|
+
* console.error(e);
|
|
3593
|
+
* throw e;
|
|
3594
|
+
* });
|
|
3595
|
+
*
|
|
3596
|
+
* ```
|
|
3597
|
+
*
|
|
3598
|
+
* @param params - Parameters for request
|
|
3599
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3600
|
+
* @param callback - Optional callback that handles the response.
|
|
3601
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3602
|
+
*/
|
|
3603
|
+
delete(params: Params$Resource$Outboundendpoints$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3604
|
+
delete(params?: Params$Resource$Outboundendpoints$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
3605
|
+
delete(params: Params$Resource$Outboundendpoints$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3606
|
+
delete(params: Params$Resource$Outboundendpoints$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3607
|
+
delete(params: Params$Resource$Outboundendpoints$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3608
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3609
|
+
/**
|
|
3610
|
+
* Fetches the representation of an existing Outbound Endpoint.
|
|
3611
|
+
* @example
|
|
3612
|
+
* ```js
|
|
3613
|
+
* // Before running the sample:
|
|
3614
|
+
* // - Enable the API at:
|
|
3615
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
3616
|
+
* // - Login into gcloud by running:
|
|
3617
|
+
* // ```sh
|
|
3618
|
+
* // $ gcloud auth application-default login
|
|
3619
|
+
* // ```
|
|
3620
|
+
* // - Install the npm module by running:
|
|
3621
|
+
* // ```sh
|
|
3622
|
+
* // $ npm install googleapis
|
|
3623
|
+
* // ```
|
|
3624
|
+
*
|
|
3625
|
+
* const {google} = require('googleapis');
|
|
3626
|
+
* const dns = google.dns('v1');
|
|
3627
|
+
*
|
|
3628
|
+
* async function main() {
|
|
3629
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3630
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3631
|
+
* scopes: [
|
|
3632
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3633
|
+
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
3634
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
|
|
3635
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
3636
|
+
* ],
|
|
3637
|
+
* });
|
|
3638
|
+
*
|
|
3639
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3640
|
+
* const authClient = await auth.getClient();
|
|
3641
|
+
* google.options({auth: authClient});
|
|
3642
|
+
*
|
|
3643
|
+
* // Do the magic
|
|
3644
|
+
* const res = await dns.outboundEndpoints.get({
|
|
3645
|
+
* // For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
3646
|
+
* clientOperationId: 'placeholder-value',
|
|
3647
|
+
* // Required. The name of the OutboundEndpoint to retrieve. Format: projects/{project\}/locations/{location\}/outboundEndpoints/{outboundEndpoint\}
|
|
3648
|
+
* name: 'projects/my-project/locations/my-location/outboundEndpoints/my-outboundEndpoint',
|
|
3649
|
+
* });
|
|
3650
|
+
* console.log(res.data);
|
|
3651
|
+
*
|
|
3652
|
+
* // Example response
|
|
3653
|
+
* // {
|
|
3654
|
+
* // "annotations": {},
|
|
3655
|
+
* // "createTime": "my_createTime",
|
|
3656
|
+
* // "description": "my_description",
|
|
3657
|
+
* // "endpointIp": "my_endpointIp",
|
|
3658
|
+
* // "labels": {},
|
|
3659
|
+
* // "name": "my_name",
|
|
3660
|
+
* // "network": "my_network",
|
|
3661
|
+
* // "subnetwork": "my_subnetwork",
|
|
3662
|
+
* // "tags": {},
|
|
3663
|
+
* // "updateTime": "my_updateTime"
|
|
3664
|
+
* // }
|
|
3665
|
+
* }
|
|
3666
|
+
*
|
|
3667
|
+
* main().catch(e => {
|
|
3668
|
+
* console.error(e);
|
|
3669
|
+
* throw e;
|
|
3670
|
+
* });
|
|
3671
|
+
*
|
|
3672
|
+
* ```
|
|
3673
|
+
*
|
|
3674
|
+
* @param params - Parameters for request
|
|
3675
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3676
|
+
* @param callback - Optional callback that handles the response.
|
|
3677
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3678
|
+
*/
|
|
3679
|
+
get(params: Params$Resource$Outboundendpoints$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3680
|
+
get(params?: Params$Resource$Outboundendpoints$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$OutboundEndpoint>>;
|
|
3681
|
+
get(params: Params$Resource$Outboundendpoints$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3682
|
+
get(params: Params$Resource$Outboundendpoints$Get, options: MethodOptions | BodyResponseCallback<Schema$OutboundEndpoint>, callback: BodyResponseCallback<Schema$OutboundEndpoint>): void;
|
|
3683
|
+
get(params: Params$Resource$Outboundendpoints$Get, callback: BodyResponseCallback<Schema$OutboundEndpoint>): void;
|
|
3684
|
+
get(callback: BodyResponseCallback<Schema$OutboundEndpoint>): void;
|
|
3685
|
+
/**
|
|
3686
|
+
* Enumerates all Outbound Endpoints associated with a project.
|
|
3687
|
+
* @example
|
|
3688
|
+
* ```js
|
|
3689
|
+
* // Before running the sample:
|
|
3690
|
+
* // - Enable the API at:
|
|
3691
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
3692
|
+
* // - Login into gcloud by running:
|
|
3693
|
+
* // ```sh
|
|
3694
|
+
* // $ gcloud auth application-default login
|
|
3695
|
+
* // ```
|
|
3696
|
+
* // - Install the npm module by running:
|
|
3697
|
+
* // ```sh
|
|
3698
|
+
* // $ npm install googleapis
|
|
3699
|
+
* // ```
|
|
3700
|
+
*
|
|
3701
|
+
* const {google} = require('googleapis');
|
|
3702
|
+
* const dns = google.dns('v1');
|
|
3703
|
+
*
|
|
3704
|
+
* async function main() {
|
|
3705
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3706
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3707
|
+
* scopes: [
|
|
3708
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3709
|
+
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
3710
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
|
|
3711
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
3712
|
+
* ],
|
|
3713
|
+
* });
|
|
3714
|
+
*
|
|
3715
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3716
|
+
* const authClient = await auth.getClient();
|
|
3717
|
+
* google.options({auth: authClient});
|
|
3718
|
+
*
|
|
3719
|
+
* // Do the magic
|
|
3720
|
+
* const res = await dns.outboundEndpoints.list({
|
|
3721
|
+
* clientOperationId: 'placeholder-value',
|
|
3722
|
+
* // Optional. The maximum number of results to return.
|
|
3723
|
+
* pageSize: 'placeholder-value',
|
|
3724
|
+
* // Optional. A page token received from a previous List call.
|
|
3725
|
+
* pageToken: 'placeholder-value',
|
|
3726
|
+
* // Required. The parent project and location from which to list resources. Format: projects/{project\}/locations/{location\}
|
|
3727
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
3728
|
+
* });
|
|
3729
|
+
* console.log(res.data);
|
|
3730
|
+
*
|
|
3731
|
+
* // Example response
|
|
3732
|
+
* // {
|
|
3733
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
3734
|
+
* // "outboundEndpoints": [],
|
|
3735
|
+
* // "unreachable": []
|
|
3736
|
+
* // }
|
|
3737
|
+
* }
|
|
3738
|
+
*
|
|
3739
|
+
* main().catch(e => {
|
|
3740
|
+
* console.error(e);
|
|
3741
|
+
* throw e;
|
|
3742
|
+
* });
|
|
3743
|
+
*
|
|
3744
|
+
* ```
|
|
3745
|
+
*
|
|
3746
|
+
* @param params - Parameters for request
|
|
3747
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3748
|
+
* @param callback - Optional callback that handles the response.
|
|
3749
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3750
|
+
*/
|
|
3751
|
+
list(params: Params$Resource$Outboundendpoints$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3752
|
+
list(params?: Params$Resource$Outboundendpoints$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListOutboundEndpointsResponse>>;
|
|
3753
|
+
list(params: Params$Resource$Outboundendpoints$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3754
|
+
list(params: Params$Resource$Outboundendpoints$List, options: MethodOptions | BodyResponseCallback<Schema$ListOutboundEndpointsResponse>, callback: BodyResponseCallback<Schema$ListOutboundEndpointsResponse>): void;
|
|
3755
|
+
list(params: Params$Resource$Outboundendpoints$List, callback: BodyResponseCallback<Schema$ListOutboundEndpointsResponse>): void;
|
|
3756
|
+
list(callback: BodyResponseCallback<Schema$ListOutboundEndpointsResponse>): void;
|
|
3757
|
+
/**
|
|
3758
|
+
* Updates an existing Outbound Endpoint.
|
|
3759
|
+
* @example
|
|
3760
|
+
* ```js
|
|
3761
|
+
* // Before running the sample:
|
|
3762
|
+
* // - Enable the API at:
|
|
3763
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
3764
|
+
* // - Login into gcloud by running:
|
|
3765
|
+
* // ```sh
|
|
3766
|
+
* // $ gcloud auth application-default login
|
|
3767
|
+
* // ```
|
|
3768
|
+
* // - Install the npm module by running:
|
|
3769
|
+
* // ```sh
|
|
3770
|
+
* // $ npm install googleapis
|
|
3771
|
+
* // ```
|
|
3772
|
+
*
|
|
3773
|
+
* const {google} = require('googleapis');
|
|
3774
|
+
* const dns = google.dns('v1');
|
|
3775
|
+
*
|
|
3776
|
+
* async function main() {
|
|
3777
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3778
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3779
|
+
* scopes: [
|
|
3780
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3781
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
3782
|
+
* ],
|
|
3783
|
+
* });
|
|
3784
|
+
*
|
|
3785
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3786
|
+
* const authClient = await auth.getClient();
|
|
3787
|
+
* google.options({auth: authClient});
|
|
3788
|
+
*
|
|
3789
|
+
* // Do the magic
|
|
3790
|
+
* const res = await dns.outboundEndpoints.patch({
|
|
3791
|
+
* // For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
3792
|
+
* clientOperationId: 'placeholder-value',
|
|
3793
|
+
* // Identifier. The resource name of the OutboundEndpoint. Format: `projects/{project\}/locations/{location\}/outboundEndpoints/{outboundEndpoint\}`
|
|
3794
|
+
* name: 'projects/my-project/locations/my-location/outboundEndpoints/my-outboundEndpoint',
|
|
3795
|
+
* // Optional. An optional request ID to identify requests.
|
|
3796
|
+
* requestId: 'placeholder-value',
|
|
3797
|
+
* // Required. The list of fields to be updated.
|
|
3798
|
+
* updateMask: 'placeholder-value',
|
|
3799
|
+
*
|
|
3800
|
+
* // Request body metadata
|
|
3801
|
+
* requestBody: {
|
|
3802
|
+
* // request body parameters
|
|
3803
|
+
* // {
|
|
3804
|
+
* // "annotations": {},
|
|
3805
|
+
* // "createTime": "my_createTime",
|
|
3806
|
+
* // "description": "my_description",
|
|
3807
|
+
* // "endpointIp": "my_endpointIp",
|
|
3808
|
+
* // "labels": {},
|
|
3809
|
+
* // "name": "my_name",
|
|
3810
|
+
* // "network": "my_network",
|
|
3811
|
+
* // "subnetwork": "my_subnetwork",
|
|
3812
|
+
* // "tags": {},
|
|
3813
|
+
* // "updateTime": "my_updateTime"
|
|
3814
|
+
* // }
|
|
3815
|
+
* },
|
|
3816
|
+
* });
|
|
3817
|
+
* console.log(res.data);
|
|
3818
|
+
*
|
|
3819
|
+
* // Example response
|
|
3820
|
+
* // {
|
|
3821
|
+
* // "done": false,
|
|
3822
|
+
* // "error": {},
|
|
3823
|
+
* // "metadata": {},
|
|
3824
|
+
* // "name": "my_name",
|
|
3825
|
+
* // "response": {}
|
|
3826
|
+
* // }
|
|
3827
|
+
* }
|
|
3828
|
+
*
|
|
3829
|
+
* main().catch(e => {
|
|
3830
|
+
* console.error(e);
|
|
3831
|
+
* throw e;
|
|
3832
|
+
* });
|
|
3833
|
+
*
|
|
3834
|
+
* ```
|
|
3835
|
+
*
|
|
3836
|
+
* @param params - Parameters for request
|
|
3837
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3838
|
+
* @param callback - Optional callback that handles the response.
|
|
3839
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3840
|
+
*/
|
|
3841
|
+
patch(params: Params$Resource$Outboundendpoints$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3842
|
+
patch(params?: Params$Resource$Outboundendpoints$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
3843
|
+
patch(params: Params$Resource$Outboundendpoints$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3844
|
+
patch(params: Params$Resource$Outboundendpoints$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3845
|
+
patch(params: Params$Resource$Outboundendpoints$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3846
|
+
patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3847
|
+
}
|
|
3848
|
+
export interface Params$Resource$Outboundendpoints$Create extends StandardParameters {
|
|
3849
|
+
/**
|
|
3850
|
+
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
3851
|
+
*/
|
|
3852
|
+
clientOperationId?: string;
|
|
3853
|
+
/**
|
|
3854
|
+
* Required. The ID to use for the OutboundEndpoint, which will become the final component of the OutboundEndpoint's resource name.
|
|
3855
|
+
*/
|
|
3856
|
+
outboundEndpointId?: string;
|
|
3857
|
+
/**
|
|
3858
|
+
* Required. The parent project and location where this OutboundEndpoint will be created. Format: projects/{project\}/locations/{location\}
|
|
3859
|
+
*/
|
|
3860
|
+
parent?: string;
|
|
3861
|
+
/**
|
|
3862
|
+
* Optional. An optional request ID to identify requests.
|
|
3863
|
+
*/
|
|
3864
|
+
requestId?: string;
|
|
3865
|
+
/**
|
|
3866
|
+
* Request body metadata
|
|
3867
|
+
*/
|
|
3868
|
+
requestBody?: Schema$OutboundEndpoint;
|
|
3869
|
+
}
|
|
3870
|
+
export interface Params$Resource$Outboundendpoints$Delete extends StandardParameters {
|
|
3871
|
+
/**
|
|
3872
|
+
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
3873
|
+
*/
|
|
3874
|
+
clientOperationId?: string;
|
|
3875
|
+
/**
|
|
3876
|
+
* Required. The name of the OutboundEndpoint to delete. Format: projects/{project\}/locations/{location\}/outboundEndpoints/{outboundEndpoint\}
|
|
3877
|
+
*/
|
|
3878
|
+
name?: string;
|
|
3879
|
+
/**
|
|
3880
|
+
* Optional. An optional request ID to identify requests.
|
|
3881
|
+
*/
|
|
3882
|
+
requestId?: string;
|
|
3883
|
+
}
|
|
3884
|
+
export interface Params$Resource$Outboundendpoints$Get extends StandardParameters {
|
|
3885
|
+
/**
|
|
3886
|
+
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
3887
|
+
*/
|
|
3888
|
+
clientOperationId?: string;
|
|
3889
|
+
/**
|
|
3890
|
+
* Required. The name of the OutboundEndpoint to retrieve. Format: projects/{project\}/locations/{location\}/outboundEndpoints/{outboundEndpoint\}
|
|
3891
|
+
*/
|
|
3892
|
+
name?: string;
|
|
3893
|
+
}
|
|
3894
|
+
export interface Params$Resource$Outboundendpoints$List extends StandardParameters {
|
|
3895
|
+
/**
|
|
3896
|
+
*
|
|
3897
|
+
*/
|
|
3898
|
+
clientOperationId?: string;
|
|
3899
|
+
/**
|
|
3900
|
+
* Optional. The maximum number of results to return.
|
|
3901
|
+
*/
|
|
3902
|
+
pageSize?: number;
|
|
3903
|
+
/**
|
|
3904
|
+
* Optional. A page token received from a previous List call.
|
|
3905
|
+
*/
|
|
3906
|
+
pageToken?: string;
|
|
3907
|
+
/**
|
|
3908
|
+
* Required. The parent project and location from which to list resources. Format: projects/{project\}/locations/{location\}
|
|
3909
|
+
*/
|
|
3910
|
+
parent?: string;
|
|
3911
|
+
}
|
|
3912
|
+
export interface Params$Resource$Outboundendpoints$Patch extends StandardParameters {
|
|
3913
|
+
/**
|
|
3914
|
+
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
3915
|
+
*/
|
|
3916
|
+
clientOperationId?: string;
|
|
3917
|
+
/**
|
|
3918
|
+
* Identifier. The resource name of the OutboundEndpoint. Format: `projects/{project\}/locations/{location\}/outboundEndpoints/{outboundEndpoint\}`
|
|
3919
|
+
*/
|
|
3920
|
+
name?: string;
|
|
3921
|
+
/**
|
|
3922
|
+
* Optional. An optional request ID to identify requests.
|
|
3923
|
+
*/
|
|
3924
|
+
requestId?: string;
|
|
3925
|
+
/**
|
|
3926
|
+
* Required. The list of fields to be updated.
|
|
3927
|
+
*/
|
|
3928
|
+
updateMask?: string;
|
|
3929
|
+
/**
|
|
3930
|
+
* Request body metadata
|
|
3931
|
+
*/
|
|
3932
|
+
requestBody?: Schema$OutboundEndpoint;
|
|
3933
|
+
}
|
|
3934
|
+
export class Resource$Policies {
|
|
3935
|
+
context: APIRequestContext;
|
|
3936
|
+
constructor(context: APIRequestContext);
|
|
3937
|
+
/**
|
|
3938
|
+
* Creates a new policy.
|
|
3939
|
+
* @example
|
|
3940
|
+
* ```js
|
|
3941
|
+
* // Before running the sample:
|
|
3942
|
+
* // - Enable the API at:
|
|
3943
|
+
* // https://console.developers.google.com/apis/api/dns.googleapis.com
|
|
3944
|
+
* // - Login into gcloud by running:
|
|
3945
|
+
* // ```sh
|
|
3946
|
+
* // $ gcloud auth application-default login
|
|
3947
|
+
* // ```
|
|
3948
|
+
* // - Install the npm module by running:
|
|
3949
|
+
* // ```sh
|
|
3950
|
+
* // $ npm install googleapis
|
|
3951
|
+
* // ```
|
|
3952
|
+
*
|
|
3953
|
+
* const {google} = require('googleapis');
|
|
3954
|
+
* const dns = google.dns('v1');
|
|
3955
|
+
*
|
|
3956
|
+
* async function main() {
|
|
3957
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3958
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3959
|
+
* scopes: [
|
|
3960
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3961
|
+
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
|
|
3962
|
+
* ],
|
|
3963
|
+
* });
|
|
3964
|
+
*
|
|
3965
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3966
|
+
* const authClient = await auth.getClient();
|
|
3967
|
+
* google.options({auth: authClient});
|
|
3968
|
+
*
|
|
3969
|
+
* // Do the magic
|
|
3970
|
+
* const res = await dns.policies.create({
|
|
2806
3971
|
* // For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
2807
3972
|
* clientOperationId: 'placeholder-value',
|
|
2808
3973
|
* // Identifies the project addressed by this request.
|
|
@@ -3366,8 +4531,6 @@ export declare namespace dns_v1 {
|
|
|
3366
4531
|
*
|
|
3367
4532
|
* // Do the magic
|
|
3368
4533
|
* const res = await dns.projects.get({
|
|
3369
|
-
* // For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
3370
|
-
* clientOperationId: 'placeholder-value',
|
|
3371
4534
|
* // Identifies the project addressed by this request.
|
|
3372
4535
|
* project: 'placeholder-value',
|
|
3373
4536
|
* });
|
|
@@ -3402,10 +4565,6 @@ export declare namespace dns_v1 {
|
|
|
3402
4565
|
get(callback: BodyResponseCallback<Schema$Project>): void;
|
|
3403
4566
|
}
|
|
3404
4567
|
export interface Params$Resource$Projects$Get extends StandardParameters {
|
|
3405
|
-
/**
|
|
3406
|
-
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
|
|
3407
|
-
*/
|
|
3408
|
-
clientOperationId?: string;
|
|
3409
4568
|
/**
|
|
3410
4569
|
* Identifies the project addressed by this request.
|
|
3411
4570
|
*/
|