@google-cloud/common

constructor

constructor(errorMessage: string);

constructor

constructor(errorBody: GoogleErrorBody);

property code

code?: number;

property errors

errors?: GoogleInnerError[];

property response

response?: r.Response;

method createMultiErrorMessage

static createMultiErrorMessage: (
    err: GoogleErrorBody,
    errors?: GoogleInnerError[]
) => string;

• Pieces together an error message by combining all unique error messages returned from a single GoogleError

  Parameter err

  The original error.

  Parameter errors

  Inner errors, if any.

  Returns

  {string}

constructor

constructor(config: ServiceObjectConfig);

• An Operation object allows you to interact with APIs that take longer to process things.

  module:common/operation

  Parameter config

  Configuration object.

  Parameter

  {module:common/service|module:common/serviceObject|module:common/grpcService|module:common/grpcServiceObject} config.parent - The parent object.

property completeListeners

completeListeners: number;

property hasActiveListeners

hasActiveListeners: boolean;

method listenForEvents_

protected listenForEvents_: () => void;

• Begin listening for events on the operation. This method keeps track of how many "complete" listeners are registered and removed, making sure polling is handled automatically.

  As long as there is one active "complete" listener, the connection is open. When there are no more listeners, the polling stops.

method poll_

protected poll_: (callback: MetadataCallback) => void;

• Poll for a status update. Returns null for an incomplete status, and metadata for a complete status.

method promise

promise: () => Promise<unknown>;

• Wraps the complete and error events in a Promise.

  {Promise}

method startPolling_

protected startPolling_: () => Promise<void>;

• Poll getMetadata to check the operation's status. This runs a loop to ping the API on an interval.

  Note: This method is automatically called once a "complete" event handler is registered on the operation.

constructor

constructor(config: ServiceConfig, options?: ServiceOptions);

• Service is a base class, meant to be inherited from by a "service," like BigQuery or Storage.

  This handles making authenticated requests by exposing a makeReq_ function.

  module:common/service

  Parameter config

  Configuration object.

  Parameter

  {string} config.baseUrl - The base URL to make API requests to.

  Parameter

  {string[]} config.scopes - The scopes required for the request.

  Parameter options

  [Configuration object](#/docs).

property apiEndpoint

readonly apiEndpoint: string;

property authClient

authClient: GoogleAuth<AuthClient>;

property baseUrl

baseUrl: string;

property interceptors

interceptors: Interceptor[];

property makeAuthenticatedRequest

makeAuthenticatedRequest: MakeAuthenticatedRequest;

property projectId

projectId: string;

property providedUserAgent

providedUserAgent?: string;

property timeout

timeout?: number;

method getProjectId

getProjectId: {
    (): Promise<string>;
    (callback: (err: Error, projectId?: string) => void): void;
};

• Get and update the Service's project ID.

  Parameter callback

  The callback function.

method getProjectIdAsync

protected getProjectIdAsync: () => Promise<string>;

method getRequestInterceptors

getRequestInterceptors: () => Function[];

• Return the user's custom request interceptors.

method request

request: (
    reqOpts: DecorateRequestOptions,
    callback: BodyResponseCallback
) => void;

• Make an authenticated API request.

  Parameter reqOpts

  Request options that are passed to request.

  Parameter

  {string} reqOpts.uri - A URI relative to the baseUrl.

  Parameter callback

  The callback function passed to request.

method requestStream

requestStream: (reqOpts: DecorateRequestOptions) => r.Request;

• Make an authenticated API request.

  Parameter reqOpts

  Request options that are passed to request.

  Parameter

  {string} reqOpts.uri - A URI relative to the baseUrl.

constructor

constructor(config: ServiceObjectConfig);

property baseUrl

baseUrl?: string;

property id

id?: string;

property interceptors

interceptors: Interceptor[];

property metadata

metadata: any;

property methods

protected methods: Methods;

property parent

parent: ServiceObjectParent;

property pollIntervalMs

pollIntervalMs?: number;

property projectId

projectId?: string;

method create

create: {
    (options?: CreateOptions): Promise<CreateResponse<T>>;
    (options: CreateOptions, callback: CreateCallback<T>): void;
    (callback: CreateCallback<T>): void;
};

• Create the object.

  Parameter options

  Configuration object.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err - An error returned while making this request.

  Parameter

  {object} callback.instance - The instance.

  Parameter

  {object} callback.apiResponse - The full API response.

method delete

delete: {
    (options?: DeleteOptions): Promise<[r.Response]>;
    (options: DeleteOptions, callback: DeleteCallback): void;
    (callback: DeleteCallback): void;
};

• Delete the object.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err - An error returned while making this request.

  Parameter

  {object} callback.apiResponse - The full API response.

method exists

exists: {
    (options?: ExistsOptions): Promise<[boolean]>;
    (options: object, callback: ExistsCallback): void;
    (callback: ExistsCallback): void;
};

• Check if the object exists.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err - An error returned while making this request.

  Parameter

  {boolean} callback.exists - Whether the object exists or not.

method get

get: {
    (options?: GetOrCreateOptions): Promise<GetResponse<T>>;
    (callback: InstanceResponseCallback<T>): void;
    (options: GetOrCreateOptions, callback: InstanceResponseCallback<T>): void;
};

• Get the object if it exists. Optionally have the object created if an options object is provided with autoCreate: true.

  Parameter options

  The configuration object that will be used to create the object if necessary.

  Parameter

  {boolean} options.autoCreate - Create the object if it doesn't already exist.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err - An error returned while making this request.

  Parameter

  {object} callback.instance - The instance.

  Parameter

  {object} callback.apiResponse - The full API response.

method getMetadata

getMetadata: {
    (options?: GetMetadataOptions): Promise<MetadataResponse>;
    (options: object, callback: MetadataCallback): void;
    (callback: MetadataCallback): void;
};

• Get the metadata of this object.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err - An error returned while making this request.

  Parameter

  {object} callback.metadata - The metadata for this object.

  Parameter

  {object} callback.apiResponse - The full API response.

method getRequestInterceptors

getRequestInterceptors: () => Function[];

• Return the user's custom request interceptors.

method request

request: {
    (reqOpts: DecorateRequestOptions): Promise<RequestResponse>;
    (reqOpts: DecorateRequestOptions, callback: BodyResponseCallback): void;
};

• Make an authenticated API request.

  Parameter reqOpts

  Request options that are passed to request.

  Parameter

  {string} reqOpts.uri - A URI relative to the baseUrl.

  Parameter callback

  The callback function passed to request.

method requestStream

requestStream: (reqOpts: DecorateRequestOptions) => r.Request;

• Make an authenticated API request.

  Parameter reqOpts

  Request options that are passed to request.

  Parameter

  {string} reqOpts.uri - A URI relative to the baseUrl.

method setMetadata

setMetadata: {
    (
        metadata: Metadata,
        options?: SetMetadataOptions
    ): Promise<SetMetadataResponse>;
    (metadata: any, callback: MetadataCallback): void;
    (metadata: any, options: object, callback: MetadataCallback): void;
};

• Set the metadata for this object.

  Parameter metadata

  The metadata to set on this object.

  Parameter options

  Configuration options.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err - An error returned while making this request.

  Parameter

  {object} callback.apiResponse - The full API response.

method abort

abort: () => void;

call signature

(err: Error | ApiError | null, body?: ResponseBody, res?: r.Response): void;

property autoPaginate

autoPaginate?: boolean;

property autoPaginateVal

autoPaginateVal?: boolean;

property interceptors_

interceptors_?: Interceptor[];

property maxRetries

maxRetries?: number;

property objectMode

objectMode?: boolean;

property projectId

projectId?: string;

property shouldReturnStream

shouldReturnStream?: boolean;

property uri

uri: string;

call signature

(err: Error | null, apiResponse?: r.Response): void;

call signature

(err: Error | null, exists?: boolean): void;

property autoCreate

autoCreate?: boolean;

• Create the object if it doesn't already exist.

call signature

(err: ApiError | null, instance?: T | null, apiResponse?: r.Response): void;

method request

request: (opts: r.Options) => DecorateRequestOptions;

index signature

[methodName: string]:
    | {
          reqOpts?: r.CoreOptions;
      }
    | boolean;

call signature

(err?: Error | null, apiResponse?: r.Response): void;

property apiEndpoint

apiEndpoint: string;

• The API Endpoint to use when connecting to the service. Example: storage.googleapis.com

property authClient

authClient?: AuthClient | GoogleAuth;

• Reuse an existing AuthClient or GoogleAuth client instead of creating a new one.

property baseUrl

baseUrl: string;

• The base URL to make API requests to.

property packageJson

packageJson: PackageJson;

property projectIdRequired

projectIdRequired?: boolean;

property scopes

scopes: string[];

• The scopes required for the request.

property baseUrl

baseUrl?: string;

• The base URL to make API requests to.

property createMethod

createMethod?: Function;

• The method which creates this object.

property id

id?: string;

• The identifier of the object. For example, the name of a Storage bucket or Pub/Sub topic.

property methods

methods?: Methods;

• A map of each method name that should be inherited.

property parent

parent: ServiceObjectParent;

• The parent service instance. For example, an instance of Storage if the object is Bucket.

property pollIntervalMs

pollIntervalMs?: number;

• For long running operations, how often should the client poll for completion.

property projectId

projectId?: string;

• Override of projectId, used to allow access to resources in another project. For example, a BigQuery dataset in another project to which the user has been granted permission.

property interceptors

interceptors: Interceptor[];

method getRequestInterceptors

getRequestInterceptors: () => Function[];

method request

request: (
    reqOpts: DecorateRequestOptions,
    callback: BodyResponseCallback
) => void;

method requestStream

requestStream: (reqOpts: DecorateRequestOptions) => r.Request;

property authClient

authClient?: AuthClient | GoogleAuth;

property email

email?: string;

property interceptors_

interceptors_?: Interceptor[];

property timeout

timeout?: number;

property token

token?: string;

property useAuthWithCustomEndpoint

useAuthWithCustomEndpoint?: boolean;

property userAgent

userAgent?: string;

property shouldReturnStream

shouldReturnStream: true;