manager/base.ts

Source: sdks/typescript/packages/sdk/src/manager/base.ts. Back to the TypeScript SDK reference index.

note

This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.

Type alias ManagerCallOptions

Per call options of the manager methods.

Definition: Pick<RequestOptions, "headers" \| "signal" \| "traceparent" \| "responseType">.

Type alias ManagerQuery

Query parameters of a manager call.

Definition: Record<string, QueryValue>.

Class ManagerResource

Base of the generated manager sub-clients: one call per Platform Manager route.

Attributes:

Name	Type	Required	Description
body	unknown,	yes	Body of the call made by the protected op helper.
method	HttpMethod,	yes	HTTP method of the call made by op; only GET, PUT and DELETE are retried.
opts	ManagerCallOptions,	yes	Per call options of op: headers, signal, traceparent and response type.
params	Record<string, string>,	yes	Values of the placeholders of the path of op.
path	string,	yes	Path template of the Platform Manager route called by op.
query	ManagerQuery,	yes	Query parameters of the call made by op.

Constructor ManagerResource

new ManagerResource(readonly http: HttpClient)

Keeps the HTTP client shared with ManagerClient.

Name	Type	Default	Required	Description
readonly http	HttpClient		yes	HTTP client of the ManagerClient.