GoogleApi.Dataflow.V1b3.Api.Projects.dataflow_projects_jobs_messages_list

You're seeing just the function dataflow_projects_jobs_messages_list, go back to GoogleApi.Dataflow.V1b3.Api.Projects module for more information.
Link to this function

dataflow_projects_jobs_messages_list(connection, project_id, job_id, optional_params \\ [], opts \\ [])

View Source

Specs

dataflow_projects_jobs_messages_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dataflow.V1b3.Model.ListJobMessagesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dataflow.V1b3.Connection.t) - Connection to server
  • project_id (type: String.t) - A project id.
  • job_id (type: String.t) - The job to get messages about.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :endTime (type: DateTime.t) - Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).
    • :location (type: String.t) - The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
    • :minimumImportance (type: String.t) - Filter to only get messages with importance >= level
    • :pageSize (type: 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 (type: String.t) - 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 (type: DateTime.t) - If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dataflow.V1b3.Model.ListJobMessagesResponse{}} on success
  • {:error, info} on failure