Class CallCredentialsAbstract

A class that represents a generic method of adding authentication-related metadata on a per-request basis.

Hierarchy

  • CallCredentials

Constructors

constructor

Methods

_equals compose generateMetadata createEmpty createFromGoogleCredential createFromMetadataGenerator

Constructors

constructor

Methods

Abstract _equals

  • _equals(other: CallCredentials): boolean

  • Check whether two call credentials objects are equal. Separate SingleCallCredentials with identical metadata generator functions are equal.

    Parameters

    Returns boolean

Abstract compose

  • Creates a new CallCredentials object from properties of both this and another CallCredentials object. This object's metadata generator will be called first.

    Parameters

    Returns CallCredentials

Abstract generateMetadata

  • Asynchronously generates a new Metadata object.

    Parameters

    • options: CallMetadataOptions

      Options used in generating the Metadata object.

    Returns Promise<Metadata>

Static createEmpty

Static createFromGoogleCredential

  • Create a gRPC credential from a Google credential object.

    Returns

    The resulting CallCredentials object.

    Parameters

    • googleCredentials: OAuth2Client

      The authentication client to use.

    Returns CallCredentials

Static createFromMetadataGenerator

  • Creates a new CallCredentials object from a given function that generates Metadata objects.

    Parameters

    • metadataGenerator: CallMetadataGenerator

      A function that accepts a set of options, and generates a Metadata object based on these options, which is passed back to the caller via a supplied (err, metadata) callback.

    Returns CallCredentials

Settings

Member Visibility

Theme

Generated using TypeDoc