Function createDirectAccessAgentBenchmark

createDirectAccessAgentBenchmark(
    agentId: string,
    query: { force?: boolean; gigaBytesToTransfer?: number },
    options?: ApiCallOptions,
): Promise<CreateDirectAccessAgentBenchmarkHttpResponse>
Starts a background benchmark task to measure the performance of a Direct Access agent. Use this endpoint to evaluate agent throughput and latency for capacity planning and performance optiization. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.8+.
Parameters
- agentId: string
  The agent ID
- query: { force?: boolean; gigaBytesToTransfer?: number }
  an object with query parameters
  - Optionalforce?: boolean
    Forces the benchmark to start regardless of the state of the agent. Does not override QCS resource limits. Use with caution.
  - OptionalgigaBytesToTransfer?: number
    The volume of data in GB to transfer during the throughput measurement part of the benchmark.
- Optionaloptions: ApiCallOptions
Returns Promise<CreateDirectAccessAgentBenchmarkHttpResponse>
Throws
CreateDirectAccessAgentBenchmarkHttpError