@nebius/js-sdk - v0.2.78
    Preparing search index...

    Interface RequestSpec<TReq>

    Describes a generated unary method to the request runtime.

    Generated service clients normally create this value. Application code does not need to construct it.

    interface RequestSpec<TReq> {
        authorizationDisable?: boolean;
        metadataParentTypes?: () => readonly string[] | undefined;
        path: string;
        requestDescriptor?: () => MessageDescriptor | undefined;
        requestDeserialize?: (value: Buffer) => TReq;
        requestFields?: readonly {
            fieldPath: string;
            nid?: { parentResource?: readonly string[]; resource?: readonly string[] };
        }[];
        requestSerialize: (value: TReq) => Buffer;
        sendResetMask?: boolean;
    }

    Type Parameters

    • TReq
    Index
    authorizationDisable? metadataParentTypes? path requestDescriptor? requestDeserialize? requestFields? requestSerialize sendResetMask?
    authorizationDisable?: boolean

    Marks anonymous API methods.

    metadataParentTypes?: () => readonly string[] | undefined

    Returns allowed parent types from the resource metadata annotation.

    Type Declaration

      • (): readonly string[] | undefined

      • Returns allowed parent types from the resource metadata annotation.

        Returns readonly string[] | undefined

    path: string

    Contains the gRPC method path, such as /package.Service/Get.

    requestDescriptor?: () => MessageDescriptor | undefined

    Returns schema data used to build a reset mask.

    Type Declaration

    requestDeserialize?: (value: Buffer) => TReq

    Copies a generated request through its protobuf codec.

    Type Declaration

      • (value: Buffer): TReq

      • Copies a generated request through its protobuf codec.

        Parameters

        • value: Buffer

        Returns TReq

    requestFields?: readonly {
        fieldPath: string;
        nid?: { parentResource?: readonly string[]; resource?: readonly string[] };
    }[]

    Contains method-specific ID annotation overrides.

    requestSerialize: (value: TReq) => Buffer

    Serializes the request message for gRPC.

    Type Declaration

      • (value: TReq): Buffer

      • Serializes the request message for gRPC.

        Parameters

        Returns Buffer

    sendResetMask?: boolean

    Controls the x-resetmask header.

    Update methods send the header by default. Set this value to false to disable that behavior for an update method.

    Settings
    Member Visibility

    On This Page
    Properties