2024-03-05
▼ ▲ aiplatform.projects.locations.ragCorpora.operations.wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+name}:wait
HTTP Method: POST
Parameters:
timeout
Type: string
Location: query
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
name
Description: The name of the operation resource to wait on.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$
Location: path
Required: Yes
▼ ▲ aiplatform.projects.locations.ragCorpora.operations.delete
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$
Location: path
Type: string
Required: Yes
Description: The name of the operation resource to be deleted.
Parameter Order: name
Path: v1beta1/{+name}
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.ragCorpora.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1beta1/{+name}/operations
Parameters:
pageToken
Location: query
Description: The standard list page token.
Type: string
name
Location: path
Description: The name of the operation's parent resource.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
filter
Location: query
Description: The standard list filter.
Type: string
pageSize
Location: query
Description: The standard list page size.
Format: int32
Type: integer
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.ragCorpora.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource.
Required: Yes
Type: string
Path: v1beta1/{+name}
Parameter Order: name
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.ragCorpora.operations.cancel
Path: v1beta1/{+name}:cancel
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Type: string
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait
Parameter Order: name
Path: v1beta1/{+name}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
timeout
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Format: google-duration
Type: string
Location: query
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Type: string
Location: path
HTTP Method: POST
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.operations.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Required: Yes
Location: path
Type: string
Description: The name of the operation's parent resource.
pageToken
Description: The standard list page token.
Type: string
Location: query
filter
Location: query
Description: The standard list filter.
Type: string
pageSize
Type: integer
Location: query
Format: int32
Description: The standard list page size.
Parameter Order: name
Path: v1beta1/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete
Path: v1beta1/{+name}
Parameter Order: name
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Required: Yes
Location: path
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel
HTTP Method: POST
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Path: v1beta1/{+name}:cancel
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Required: Yes
Type: string
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.operations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource.
Type: string
HTTP Method: GET
Parameter Order: name
Path: v1beta1/{+name}