UNPKG

@animeapis/hub

Version:
181 lines (180 loc) 9.76 kB
import * as gax from 'google-gax'; import { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax'; import * as protos from '../../protos/protos'; /** * @class * @memberof v1alpha1 */ export declare class GitClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; gitStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of GitClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or * .p12 key downloaded from the Google Developers Console. If you provide * a path to a JSON file, the projectId option below is not necessary. * NOTE: .pem and .p12 require you to specify options.email as well. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - The project ID from the Google * Developer's Console, e.g. 'grape-spaceship-123'. We will also check * the environment variable GCLOUD_PROJECT for your project ID. If your * app is running in an environment which supports * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP fallback mode. * In fallback mode, a special browser-compatible transport implementation is used * instead of gRPC transport. In browser context (if the `window` object is defined) * the fallback mode is enabled automatically; set `options.fallback` to `false` * if you need to override this behavior. */ constructor(opts?: ClientOptions); /** * Initialize the client. * Performs asynchronous operations (such as authentication) and prepares the client. * This function will be called automatically when any class method is called for the * first time, but if you need to initialize it before calling an actual method, * feel free to call initialize() directly. * * You can await on this method if you want to make sure the client is initialized. * * @returns {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath(), * exists for compatibility reasons. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): never[]; getProjectId(): Promise<string>; getProjectId(callback: Callback<string, undefined, undefined>): void; /** * * @param {Object} request * The request object that will be sent. * @param {string} request.name * The resource name of the repository. * @param {string} request.service * The git service according to the git protocol. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing [HttpBody]{@link google.api.HttpBody}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. * @example <caption>include:samples/generated/v1alpha1/git.advertise_references.js</caption> * region_tag:hub_v1alpha1_generated_Git_AdvertiseReferences_async */ advertiseReferences(request?: protos.animeshon.hub.v1alpha1.IAdvertiseReferencesRequest, options?: CallOptions): Promise<[ protos.google.api.IHttpBody, protos.animeshon.hub.v1alpha1.IAdvertiseReferencesRequest | undefined, {} | undefined ]>; advertiseReferences(request: protos.animeshon.hub.v1alpha1.IAdvertiseReferencesRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.animeshon.hub.v1alpha1.IAdvertiseReferencesRequest | null | undefined, {} | null | undefined>): void; advertiseReferences(request: protos.animeshon.hub.v1alpha1.IAdvertiseReferencesRequest, callback: Callback<protos.google.api.IHttpBody, protos.animeshon.hub.v1alpha1.IAdvertiseReferencesRequest | null | undefined, {} | null | undefined>): void; /** * * @param {Object} request * The request object that will be sent. * @param {string} request.name * The resource name of the repository. * @param {google.api.HttpBody} request.body * The request content, represented as an HttpBody. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing [HttpBody]{@link google.api.HttpBody}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. * @example <caption>include:samples/generated/v1alpha1/git.receive_pack.js</caption> * region_tag:hub_v1alpha1_generated_Git_ReceivePack_async */ receivePack(request?: protos.animeshon.hub.v1alpha1.IReceivePackRequest, options?: CallOptions): Promise<[ protos.google.api.IHttpBody, protos.animeshon.hub.v1alpha1.IReceivePackRequest | undefined, {} | undefined ]>; receivePack(request: protos.animeshon.hub.v1alpha1.IReceivePackRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.animeshon.hub.v1alpha1.IReceivePackRequest | null | undefined, {} | null | undefined>): void; receivePack(request: protos.animeshon.hub.v1alpha1.IReceivePackRequest, callback: Callback<protos.google.api.IHttpBody, protos.animeshon.hub.v1alpha1.IReceivePackRequest | null | undefined, {} | null | undefined>): void; /** * * @param {Object} request * The request object that will be sent. * @param {string} request.name * The resource name of the repository. * @param {google.api.HttpBody} request.body * The request content, represented as an HttpBody. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing [HttpBody]{@link google.api.HttpBody}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. * @example <caption>include:samples/generated/v1alpha1/git.upload_pack.js</caption> * region_tag:hub_v1alpha1_generated_Git_UploadPack_async */ uploadPack(request?: protos.animeshon.hub.v1alpha1.IUploadPackRequest, options?: CallOptions): Promise<[ protos.google.api.IHttpBody, protos.animeshon.hub.v1alpha1.IUploadPackRequest | undefined, {} | undefined ]>; uploadPack(request: protos.animeshon.hub.v1alpha1.IUploadPackRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.animeshon.hub.v1alpha1.IUploadPackRequest | null | undefined, {} | null | undefined>): void; uploadPack(request: protos.animeshon.hub.v1alpha1.IUploadPackRequest, callback: Callback<protos.google.api.IHttpBody, protos.animeshon.hub.v1alpha1.IUploadPackRequest | null | undefined, {} | null | undefined>): void; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise<void>; }