Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class Service (5.0.2)

Package

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

Parameters
Name	Description
`config`	`ServiceConfig` Configuration object.
`options`	`ServiceOptions` [Configuration object](#/docs).

readonly apiEndpoint: string;

authClient: GoogleAuth;

baseUrl: string;

interceptors: Interceptor[];

makeAuthenticatedRequest: MakeAuthenticatedRequest;

projectId: string;

providedUserAgent?: string;

timeout?: number;

getProjectId(): Promise<string>;

Get and update the Service's project ID.

Returns
Type	Description
`Promise<string>`

getProjectId(callback: (err: Error | null, projectId?: string) => void): void;

Parameter
Name	Description
`callback`	`(err: Error \| null, projectId?: string) => void`

Returns
Type	Description
`void`

protected getProjectIdAsync(): Promise<string>;

Returns
Type	Description
`Promise<string>`

getRequestInterceptors(): Function[];

Return the user's custom request interceptors.

Returns
Type	Description
`Function[]`

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

Make an authenticated API request.

Parameters
Name	Description
`reqOpts`	`DecorateRequestOptions` Request options that are passed to `request`.
`callback`	`BodyResponseCallback` The callback function passed to `request`.

Returns
Type	Description
`void`

requestStream(reqOpts: DecorateRequestOptions): r.Request;

Make an authenticated API request.

Parameter
Name	Description
`reqOpts`	`DecorateRequestOptions` Request options that are passed to `request`.

Returns
Type	Description
`r.Request`