pageDescriptor.d.ts
1.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
/**
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/// <reference types="node" />
import { Transform } from 'stream';
import { APICaller } from '../apiCaller';
import { GaxCall, RequestType } from '../apitypes';
import { Descriptor } from '../descriptor';
import { CallSettings } from '../gax';
export interface ResponseType {
[index: string]: string;
}
/**
* A descriptor for methods that support pagination.
*/
export declare class PageDescriptor implements Descriptor {
requestPageTokenField: string;
responsePageTokenField: string;
requestPageSizeField?: string;
resourceField: string;
constructor(requestPageTokenField: string, responsePageTokenField: string, resourceField: string);
/**
* Creates a new object Stream which emits the resource on 'data' event.
*/
createStream(apiCall: GaxCall, request: {}, options: CallSettings): Transform;
/**
* Create an async iterable which can be recursively called for data on-demand.
*/
asyncIterate(apiCall: GaxCall, request: RequestType, options?: CallSettings): AsyncIterable<{} | undefined>;
createIterator(apiCall: GaxCall, request: RequestType, options: CallSettings): AsyncIterable<{} | undefined>;
getApiCaller(settings: CallSettings): APICaller;
}