Skip to content

Commit 6fbfdc0

Browse files
vertex-sdk-botcopybara-github
authored andcommitted
feat: Adds cancel_query_job to SDK for agent engine long running async tasks.
PiperOrigin-RevId: 896911226
1 parent 71ef295 commit 6fbfdc0

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

src/genai/types/common.ts

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2467,6 +2467,34 @@ export declare interface RunQueryJobResult {
24672467
outputGcsUri?: string;
24682468
}
24692469

2470+
/** Config for canceling async querying agent engines. */
2471+
export declare interface CancelQueryJobAgentEngineConfig {
2472+
/** Used to override HTTP request options. */
2473+
httpOptions?: genaiTypes.HttpOptions;
2474+
/** Abort signal which can be used to cancel the request.
2475+
2476+
NOTE: AbortSignal is a client-only operation. Using it to cancel an
2477+
operation will not cancel the request in the service. You will still
2478+
be charged usage for any applicable operations.
2479+
*/
2480+
abortSignal?: AbortSignal;
2481+
/** Name of the longrunning operation returned from run_query_job. */
2482+
operationName?: string;
2483+
}
2484+
2485+
/** Result of canceling a query job. */
2486+
export declare interface CancelQueryJobResult {
2487+
/** Used to override HTTP request options. */
2488+
httpOptions?: genaiTypes.HttpOptions;
2489+
/** Abort signal which can be used to cancel the request.
2490+
2491+
NOTE: AbortSignal is a client-only operation. Using it to cancel an
2492+
operation will not cancel the request in the service. You will still
2493+
be charged usage for any applicable operations.
2494+
*/
2495+
abortSignal?: AbortSignal;
2496+
}
2497+
24702498
/** Config for async querying agent engines. */
24712499
export declare interface CheckQueryJobAgentEngineConfig {
24722500
/** Used to override HTTP request options. */

0 commit comments

Comments
 (0)