JobCollectionResponse
Represents a page of asynchronous jobs.
For the list of response object types, see Response Objects.
Use JobCollectionResponse to inspect job list results and pagination metadata for vector load jobs or index jobs.
Attributes
| Attribute | Type | Description |
|---|---|---|
items |
list of VecDBJobItem or None |
Jobs returned in the current page. |
has_more |
bool or None |
Indicates whether another page of jobs is available. |
limit |
int or None |
Page size limit applied by the service. |
offset |
int or None |
Offset used for the current page. |
count |
int or None |
Number of jobs returned in the current page. |
links |
list[LinkRelation] or None |
Hypermedia links returned by the service. |
VecDBJobItem
Represents one asynchronous job returned in the items list of a JobCollectionResponse response.
Attributes
| Attribute | Type | Description |
|---|---|---|
job_name |
str or None |
Name of the job. |
job_creator |
str or None |
User that created the job. |
job_type |
str or None |
Type of job. |
operation |
str or None |
Operation performed by the job. |
state |
str or None |
Current state of the job. |
start_date |
str or None |
Job start date. |
links |
list[LinkRelation] or None |
Hypermedia links returned by the service. |
Iterate Items
Iterate over response.items to inspect each job.
response = client.list_vector_load_jobs()
for job in response.items or []:
print(job.job_name, job.state)
Methods
| Method | Return Type | Description |
|---|---|---|
model_dump() |
dict[str, Any] |
Returns a dictionary representation of the response. |
model_dump_json() |
str |
Returns a JSON string representation of the response. |
to_dict() |
dict[str, Any] |
Returns a dictionary representation compatible with earlier SDK response handling. |
to_json() |
str |
Returns a JSON string representation compatible with earlier SDK response handling. |
to_str() |
str |
Returns a readable string representation compatible with earlier SDK response handling. |
model_validate(obj) |
JobCollectionResponse |
Creates a response object from a dictionary payload. |
model_validate_json(json_data) |
JobCollectionResponse |
Creates a response object from a JSON string. |
Iterate Attributes
Use serialization helpers to iterate response attributes and item attributes.
response = client.list_vector_load_jobs()
payload = response.to_dict()
for attribute, value in payload.items():
print(attribute, value)
for job in response.items or []:
job_payload = job.to_dict()
for attribute, value in job_payload.items():
print(attribute, value)
Sample Response
{
"items": [
{
"job_name": "VECTOR_LOAD_JOB_123",
"job_creator": "VECTOR3",
"job_type": "VECTOR_LOAD",
"operation": "LOAD_VECTORS",
"state": "SUCCEEDED",
"start_date": "2026-03-12T11:21:30Z"
}
],
"hasMore": false,
"limit": 25,
"offset": 0,
"count": 1
}
Returned By
Returned by: list_vector_load_jobs(), list_index_jobs().