Dataflow API . projects . locations . jobs . messages

close()

Close httplib2 connections.

list(projectId, location, jobId, endTime=None, minimumImportance=None, pageSize=None, pageToken=None, startTime=None, x__xgafv=None)

Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.messages.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.messages.list` is not recommended, as you can only request the status of jobs that are running in `us-central1`.

Args:
  projectId: string, A project id. (required)
  location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)
  jobId: string, The job to get messages about. (required)
  endTime: string, Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).
  minimumImportance: string, Filter to only get messages with importance >= level
    Allowed values
      JOB_MESSAGE_IMPORTANCE_UNKNOWN - The message importance isn't specified, or is unknown.
      JOB_MESSAGE_DEBUG - The message is at the 'debug' level: typically only useful for software engineers working on the code the job is running. Typically, Dataflow pipeline runners do not display log messages at this level by default.
      JOB_MESSAGE_DETAILED - The message is at the 'detailed' level: somewhat verbose, but potentially useful to users. Typically, Dataflow pipeline runners do not display log messages at this level by default. These messages are displayed by default in the Dataflow monitoring UI.
      JOB_MESSAGE_BASIC - The message is at the 'basic' level: useful for keeping track of the execution of a Dataflow pipeline. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.
      JOB_MESSAGE_WARNING - The message is at the 'warning' level: indicating a condition pertaining to a job which may require human intervention. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.
      JOB_MESSAGE_ERROR - The message is at the 'error' level: indicating a condition preventing a job from succeeding. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.
  pageSize: integer, If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.
  pageToken: string, If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.
  startTime: string, If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to a request to list job messages.
  "autoscalingEvents": [ # Autoscaling events in ascending timestamp order.
    { # A structured message reporting an autoscaling decision made by the Dataflow service.
      "currentNumWorkers": "A String", # The current number of workers the job has.
      "description": { # A rich message format, including a human readable string, a key for identifying the message, and structured data associated with the message for programmatic consumption. # A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers.
        "messageKey": "A String", # Identifier for this message type. Used by external systems to internationalize or personalize message.
        "messageText": "A String", # Human-readable version of message.
        "parameters": [ # The structured data associated with this message.
          { # Structured data associated with this message.
            "key": "A String", # Key or name for this parameter.
            "value": "", # Value for this parameter.
          },
        ],
      },
      "eventType": "A String", # The type of autoscaling event to report.
      "targetNumWorkers": "A String", # The target number of workers the worker pool wants to resize to use.
      "time": "A String", # The time this event was emitted to indicate a new target or current num_workers value.
      "workerPool": "A String", # A short and friendly name for the worker pool this event refers to.
    },
  ],
  "jobMessages": [ # Messages in ascending timestamp order.
    { # A particular message pertaining to a Dataflow job.
      "id": "A String", # Deprecated.
      "messageImportance": "A String", # Importance level of the message.
      "messageText": "A String", # The text of the message.
      "time": "A String", # The timestamp of the message.
    },
  ],
  "nextPageToken": "A String", # The token to obtain the next page of results if there are more.
}

list_next(previous_request, previous_response)

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.