@animeapis/hub/build/src/v1alpha1/hub_client.d.ts

Animeshon Hub API Client for Node.js

/// <reference types="node" />
import * as gax from 'google-gax';
import { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 * @class
 * @memberof v1alpha1
 */
export declare class HubClient {
    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;
    };
    hubStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of HubClient.
     *
     * @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 to be created.
     * @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 [Repository]{@link animeshon.hub.v1alpha1.Repository}.
     *   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/hub.create_repository.js</caption>
     * region_tag:hub_v1alpha1_generated_Hub_CreateRepository_async
     */
    createRepository(request?: protos.animeshon.hub.v1alpha1.ICreateRepositoryRequest, options?: CallOptions): Promise<[
        protos.animeshon.hub.v1alpha1.IRepository,
        protos.animeshon.hub.v1alpha1.ICreateRepositoryRequest | undefined,
        {} | undefined
    ]>;
    createRepository(request: protos.animeshon.hub.v1alpha1.ICreateRepositoryRequest, options: CallOptions, callback: Callback<protos.animeshon.hub.v1alpha1.IRepository, protos.animeshon.hub.v1alpha1.ICreateRepositoryRequest | null | undefined, {} | null | undefined>): void;
    createRepository(request: protos.animeshon.hub.v1alpha1.ICreateRepositoryRequest, callback: Callback<protos.animeshon.hub.v1alpha1.IRepository, protos.animeshon.hub.v1alpha1.ICreateRepositoryRequest | 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 to be deleted.
     * @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 [Empty]{@link google.protobuf.Empty}.
     *   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/hub.delete_repository.js</caption>
     * region_tag:hub_v1alpha1_generated_Hub_DeleteRepository_async
     */
    deleteRepository(request?: protos.animeshon.hub.v1alpha1.IDeleteRepositoryRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.animeshon.hub.v1alpha1.IDeleteRepositoryRequest | undefined,
        {} | undefined
    ]>;
    deleteRepository(request: protos.animeshon.hub.v1alpha1.IDeleteRepositoryRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.animeshon.hub.v1alpha1.IDeleteRepositoryRequest | null | undefined, {} | null | undefined>): void;
    deleteRepository(request: protos.animeshon.hub.v1alpha1.IDeleteRepositoryRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.animeshon.hub.v1alpha1.IDeleteRepositoryRequest | null | undefined, {} | null | undefined>): void;
    /**
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   The parent, which owns this collection of repositories.
    * @param {number} request.pageSize
    *   If unspecified, server will pick an appropriate default.
    * @param {string} request.pageToken
    *   The value returned from the previous call.
    * @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 Array of [Repository]{@link animeshon.hub.v1alpha1.Repository}.
    *   The client library will perform auto-pagination by default: it will call the API as many
    *   times as needed and will merge results from all the pages into this array.
    *   Note that it can affect your quota.
    *   We recommend using `listRepositoriesAsync()`
    *   method described below for async iteration which you can stop as needed.
    *   Please see the
    *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
    *   for more details and examples.
    */
    listRepositories(request?: protos.animeshon.hub.v1alpha1.IListRepositoriesRequest, options?: CallOptions): Promise<[
        protos.animeshon.hub.v1alpha1.IRepository[],
        protos.animeshon.hub.v1alpha1.IListRepositoriesRequest | null,
        protos.animeshon.hub.v1alpha1.IListRepositoriesResponse
    ]>;
    listRepositories(request: protos.animeshon.hub.v1alpha1.IListRepositoriesRequest, options: CallOptions, callback: PaginationCallback<protos.animeshon.hub.v1alpha1.IListRepositoriesRequest, protos.animeshon.hub.v1alpha1.IListRepositoriesResponse | null | undefined, protos.animeshon.hub.v1alpha1.IRepository>): void;
    listRepositories(request: protos.animeshon.hub.v1alpha1.IListRepositoriesRequest, callback: PaginationCallback<protos.animeshon.hub.v1alpha1.IListRepositoriesRequest, protos.animeshon.hub.v1alpha1.IListRepositoriesResponse | null | undefined, protos.animeshon.hub.v1alpha1.IRepository>): void;
    /**
     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   The parent, which owns this collection of repositories.
     * @param {number} request.pageSize
     *   If unspecified, server will pick an appropriate default.
     * @param {string} request.pageToken
     *   The value returned from the previous call.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Stream}
     *   An object stream which emits an object representing [Repository]{@link animeshon.hub.v1alpha1.Repository} on 'data' event.
     *   The client library will perform auto-pagination by default: it will call the API as many
     *   times as needed. Note that it can affect your quota.
     *   We recommend using `listRepositoriesAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the
     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
     *   for more details and examples.
     */
    listRepositoriesStream(request?: protos.animeshon.hub.v1alpha1.IListRepositoriesRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listRepositories`, but returns an iterable object.
     *
     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   The parent, which owns this collection of repositories.
     * @param {number} request.pageSize
     *   If unspecified, server will pick an appropriate default.
     * @param {string} request.pageToken
     *   The value returned from the previous call.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Object}
     *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
     *   When you iterate the returned iterable, each element will be an object representing
     *   [Repository]{@link animeshon.hub.v1alpha1.Repository}. The API will be called under the hood as needed, once per the page,
     *   so you can stop the iteration when you don't need more results.
     *   Please see the
     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1alpha1/hub.list_repositories.js</caption>
     * region_tag:hub_v1alpha1_generated_Hub_ListRepositories_async
     */
    listRepositoriesAsync(request?: protos.animeshon.hub.v1alpha1.IListRepositoriesRequest, options?: CallOptions): AsyncIterable<protos.animeshon.hub.v1alpha1.IRepository>;
    /**
     * 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>;
}