Data pipelines API . projects . locations . pipelines . jobs

close()

Close httplib2 connections.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the caller doesn't have permission to access it.

Args:
  parent: string, Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. (required)
  pageSize: integer, The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the max limit will be determined by the backend implementation.
  pageToken: string, A page token, received from a previous `ListJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListJobs` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListJobs
  "jobs": [ # Results that were accessible to the caller. Results are always in descending order of job creation date.
    { # Definition of the job information maintained by the pipeline. Fields in this entity are retrieved from the executor API (e.g. Dataflow API).
      "createTime": "A String", # Output only. The time of job creation.
      "dataflowJobDetails": { # Pipeline job details specific to the Dataflow API. This is encapsulated here to allow for more executors to store their specific details separately. # All the details that are specific to a Dataflow job.
        "currentWorkers": 42, # Output only. The current number of workers used to run the jobs. Only set to a value if the job is still running.
        "resourceInfo": { # Cached version of all the metrics of interest for the job. This value gets stored here when the job is terminated. As long as the job is running, this field is populated from the Dataflow API.
          "a_key": 3.14,
        },
        "sdkVersion": { # The version of the SDK used to run the job. # Output only. The SDK version used to run the job.
          "sdkSupportStatus": "A String", # The support status for this SDK version.
          "version": "A String", # The version of the SDK used to run the job.
          "versionDisplayName": "A String", # A readable string describing the version of the SDK.
        },
      },
      "endTime": "A String", # Output only. The time of job termination. This is absent if the job is still running.
      "id": "A String", # Output only. The internal ID for the job.
      "name": "A String", # Required. The fully qualified resource name for the job.
      "state": "A String", # The current state of the job.
      "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Status capturing any error code or message related to job creation or execution.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.