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

    Interface WithVpc_peering_ItemRequestBuilder

    Builds and executes requests for operations under /v2/vpc_peerings/{vpc_peering_id}

    interface WithVpc_peering_ItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithVpc_peering_DeleteResponse>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithVpc_peering_GetResponse>;
        patch(
            body: WithVpc_peering_PatchRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithVpc_peering_PatchResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPatchRequestInformation(
            body: WithVpc_peering_PatchRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithVpc_peering_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete get patch toDeleteRequestInformation toGetRequestInformation toPatchRequestInformation withUrl

    Methods

    • To delete a VPC peering, send a DELETE request to /v2/vpc_peerings/$VPC_PEERING_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithVpc_peering_DeleteResponse>

      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 show information about an existing VPC Peering, send a GET request to /v2/vpc_peerings/$VPC_PEERING_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithVpc_peering_GetResponse>

      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 update the name of a VPC peering, send a PATCH request to /v2/vpc_peerings/$VPC_PEERING_ID with the new name in the request body.

      Parameters

      • body: WithVpc_peering_PatchRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithVpc_peering_PatchResponse>

      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 VPC peering, send a DELETE request to /v2/vpc_peerings/$VPC_PEERING_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To show information about an existing VPC Peering, send a GET request to /v2/vpc_peerings/$VPC_PEERING_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update the name of a VPC peering, send a PATCH request to /v2/vpc_peerings/$VPC_PEERING_ID with the new name in the request body.

      Parameters

      • body: WithVpc_peering_PatchRequestBody

        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