Interface BandwidthRequestBuilder

Builds and executes requests for operations under /v2/monitoring/metrics/droplet/bandwidth

interface BandwidthRequestBuilder {
    get(
        requestConfiguration?: RequestConfiguration<
            BandwidthRequestBuilderGetQueryParameters,
        >,
    ): Promise<undefined | Metrics>;
    toGetRequestInformation(
        requestConfiguration?: RequestConfiguration<
            BandwidthRequestBuilderGetQueryParameters,
        >,
    ): RequestInformation;
    withUrl(rawUrl: string): BandwidthRequestBuilder;
}

Hierarchy

BaseRequestBuilder<BandwidthRequestBuilder>
- BandwidthRequestBuilder

Index

Methods

get toGetRequestInformation withUrl

Methods

get

get(
    requestConfiguration?: RequestConfiguration<
        BandwidthRequestBuilderGetQueryParameters,
    >,
): Promise<undefined | Metrics>
To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traffic.The metrics in the response body are in megabits per second (Mbps).
Parameters
- OptionalrequestConfiguration: RequestConfiguration<BandwidthRequestBuilderGetQueryParameters>
  Configuration for the request such as headers, query parameters, and middleware options.
Returns Promise<undefined | Metrics>
Throws
error when the service returns a 401 status code

Throws
error when the service returns a 429 status code

Throws
error when the service returns a 500 status code

Throws
error when the service returns a 4XX or 5XX status code
- Defined in src/dots/v2/monitoring/metrics/droplet/bandwidth/index.ts:22

toGetRequestInformation

toGetRequestInformation(
    requestConfiguration?: RequestConfiguration<
        BandwidthRequestBuilderGetQueryParameters,
    >,
): RequestInformation
To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traffic.The metrics in the response body are in megabits per second (Mbps).
Parameters
- OptionalrequestConfiguration: RequestConfiguration<BandwidthRequestBuilderGetQueryParameters>
  Configuration for the request such as headers, query parameters, and middleware options.
Returns RequestInformation
- Defined in src/dots/v2/monitoring/metrics/droplet/bandwidth/index.ts:28

withUrl

withUrl(rawUrl: string): BandwidthRequestBuilder
Parameters
- rawUrl: string
Returns BandwidthRequestBuilder
Inherited from BaseRequestBuilder.withUrl
- Defined in node_modules/@microsoft/kiota-abstractions/dist/es/src/baseRequestBuilder.d.ts:8