Sign in
gateway.openapi_Gateway

List Batch Inference Jobs

get/v1/accounts/{account_id}/batchInferenceJobs

Path parameters

account_idstring required

The Account Id

Query parameters

pageSizeinteger

The maximum number of batch inference jobs to return. The maximum page_size is 200, values above 200 will be coerced to 200. If unspecified, the default is 50.

pageTokenstring

A page token, received from a previous ListBatchInferenceJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBatchInferenceJobs must match the call that provided the page token.

filterstring

Only jobs satisfying the provided filter (if specified) will be returned. See https://google.aip.dev/160 for the filter grammar.

orderBystring

A comma-separated list of fields to order by. e.g. "foo,bar" The default sort order is ascending. To specify a descending order for a field, append a " desc" suffix. e.g. "foo desc,bar" Subfields are specified with a "." character. e.g. "foo.bar" If not specified, the default order is by "created_time".

readMaskstring

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

A successful response.

nextPageTokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSizeinteger

The total number of batch inference jobs.

Changes

Changed in 3 of the 27 revisions of this API.33

  • 4506ec9d12ff1See the full diff
    • ●

      added the new JOB_STATE_PAUSED enum value to the // response property for the response status

      response-property-enum-value-added

  • 824e683281d41See the full diff
    • ●

      added the new JOB_STATE_EARLY_STOPPED enum value to the // response property for the response status

      response-property-enum-value-added

  • 311efdb2fa5713See the full diff
    • ●

      added the new JOB_STATE_CANCELLING enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • ○

      api tag gateway.openapi_Gateway added

      api-tag-added

    • ○

      api tag Gateway removed

      api-tag-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog