Method: jobs.list

Full name: projects.locations.instances.integrations.jobs.list

jobs.list lists IntegrationJobs.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list IntegrationJobs for. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of IntegrationJobs to return. The service may return fewer than this value.

pageToken

string

Optional. A page token, received from a previous jobs.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListBooks must match the call that provided the page token.

filter

string

Optional. A filter to apply to the list results. Only the following filters are allowed: - id - custom - system - author - version - integration

orderBy

string

Optional. A field to order the results by.

excludeStaging

boolean

Optional. Exclude staging jobs from the response. By default, staging jobs are included.

Request body

The request body must be empty.

Response body

Response message for jobs.list.

If successful, the response body contains data with the following structure:

JSON representation
{
  "jobs": [
    {
      object (IntegrationJob)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
jobs[]

object (IntegrationJob)

The list of IntegrationJobs.

nextPageToken

string

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

totalSize

integer

Total number of IntegrationJobs.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.