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

    Interface WithDestination_uuItemRequestBuilder

    Builds and executes requests for operations under /v2/monitoring/sinks/destinations/{destination_uuid}

    interface WithDestination_uuItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithDestination_uuGetResponse>;
        post(
            body: Destination_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: Destination_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithDestination_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete get post toDeleteRequestInformation toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To delete a destination and all associated sinks, send a DELETE request to /v2/monitoring/sinks/destinations/${destination_uuid}.

      Parameters

      • 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 get the details of a destination, send a GET request to /v2/monitoring/sinks/destinations/${destination_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithDestination_uuGetResponse>

      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: Destination_request,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<void>

      To update the details of a destination, send a PATCH request to /v2/monitoring/sinks/destinations/${destination_uuid}.

      Parameters

      • body: Destination_request

        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 delete a destination and all associated sinks, send a DELETE request to /v2/monitoring/sinks/destinations/${destination_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To get the details of a destination, send a GET request to /v2/monitoring/sinks/destinations/${destination_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update the details of a destination, send a PATCH request to /v2/monitoring/sinks/destinations/${destination_uuid}.

      Parameters

      • body: Destination_request

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods