1
0

clientInterface.d.ts 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. import { GrpcClientOptions, ClientStubOptions } from './grpc';
  2. import * as gax from './gax';
  3. import { GoogleAuthOptions } from 'google-auth-library';
  4. import { BundleDescriptor, LongrunningDescriptor, PageDescriptor, StreamDescriptor } from './descriptor';
  5. import * as longrunning from './longRunningCalls/longrunning';
  6. import * as operationProtos from '../protos/operations';
  7. export interface ClientOptions extends GrpcClientOptions, GoogleAuthOptions, ClientStubOptions {
  8. libName?: string;
  9. libVersion?: string;
  10. clientConfig?: gax.ClientConfig;
  11. fallback?: boolean | 'rest' | 'proto';
  12. apiEndpoint?: string;
  13. gaxServerStreamingRetries?: boolean;
  14. universeDomain?: string;
  15. universe_domain?: string;
  16. }
  17. export interface Descriptors {
  18. page: {
  19. [name: string]: PageDescriptor;
  20. };
  21. stream: {
  22. [name: string]: StreamDescriptor;
  23. };
  24. longrunning: {
  25. [name: string]: LongrunningDescriptor;
  26. };
  27. batching?: {
  28. [name: string]: BundleDescriptor;
  29. };
  30. }
  31. export interface Callback<ResponseObject, NextRequestObject, RawResponseObject> {
  32. (err: Error | null | undefined, value?: ResponseObject | null, nextRequest?: NextRequestObject, rawResponse?: RawResponseObject): void;
  33. }
  34. export interface LROperation<ResultType, MetadataType> extends longrunning.Operation {
  35. promise(): Promise<[
  36. ResultType,
  37. MetadataType,
  38. operationProtos.google.longrunning.Operation
  39. ]>;
  40. }
  41. export interface PaginationCallback<RequestObject, ResponseObject, ResponseType> {
  42. (err: Error | null, values?: ResponseType[], nextPageRequest?: RequestObject, rawResponse?: ResponseObject): void;
  43. }
  44. export interface PaginationResponse<RequestObject, ResponseObject, ResponseType> {
  45. values?: ResponseType[];
  46. nextPageRequest?: RequestObject;
  47. rawResponse?: ResponseObject;
  48. }