@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface SinksRequestBuilder

    Builds and executes requests for operations under /v2/monitoring/sinks

    interface SinksRequestBuilder {
        get destinations(): DestinationsRequestBuilder;
        bySink_uuid(sink_uuid: string): WithSink_uuItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                SinksRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | SinksGetResponse>;
        post(
            body: SinksPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                SinksRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: SinksPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): SinksRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    destinations

    Methods

    bySink_uuid get post toGetRequestInformation toPostRequestInformation withUrl

    Accessors

    Methods

    • To list all sinks, send a GET request to /v2/monitoring/sinks.

      Parameters

      Returns Promise<undefined | SinksGetResponse>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    post

    • post(
          body: SinksPostRequestBody,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<void>

      To create a new sink, send a POST request to /v2/monitoring/sinks. Forwards logs from the resources identified in resources to the specified pre-existing destination.

      Parameters

      • body: SinksPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To create a new sink, send a POST request to /v2/monitoring/sinks. Forwards logs from the resources identified in resources to the specified pre-existing destination.

      Parameters

      • body: SinksPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns SinksRequestBuilder

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods