ADK for TypeScript: API Reference
    Preparing search index...

    Interface APIHubToolsetOptions

    Options for APIHubToolset.

    interface APIHubToolsetOptions {
        accessToken?: string;
        apihubClient?: BaseAPIHubClient;
        apihubResourceName: string;
        authCredential?: AuthCredential;
        authScheme?: SecuritySchemeObject;
        description?: string;
        lazyLoadSpec?: boolean;
        name?: string;
        serviceAccountJson?: string;
    }
    accessToken?: string

    An OAuth access token for API Hub, for example the output of gcloud auth print-access-token. Ignored when apihubClient is set.

    apihubClient?: BaseAPIHubClient

    The client that fetches the spec. Defaults to an APIHubClient built from accessToken and serviceAccountJson.

    apihubResourceName: string

    The API Hub resource to build tools from. It must name an API, and may also name a version and a spec, for example projects/my-project/locations/us-central1/apis/my-api. An API Hub console URL is also accepted.

    When it names a spec, that spec is used. Otherwise the first spec of the named version, or of the first version of the named API, is used.

    authCredential?: AuthCredential

    Auth credential applied to every tool the spec produces.

    authScheme?: SecuritySchemeObject

    Auth scheme applied to every tool the spec produces.

    description?: string

    The toolset description. When empty, it is set from the spec's info.description.

    lazyLoadSpec?: boolean

    When true, the spec is fetched on the first call to getTools or getTool instead of when the toolset is constructed.

    name?: string

    The toolset name. When empty, it is set from the spec's info.title in snake_case, or unnamed when the spec has no title.

    serviceAccountJson?: string

    The content of a service account key file, as a JSON string, used to authenticate to API Hub when accessToken is not set. Ignored when apihubClient is set.

    Properties