GoogleApi.Dataflow.V1b3.Api.Projects.dataflow_projects_locations_jobs_get_metrics
You're seeing just the function
dataflow_projects_locations_jobs_get_metrics
, go back to GoogleApi.Dataflow.V1b3.Api.Projects module for more information.
Link to this function
dataflow_projects_locations_jobs_get_metrics(connection, project_id, location, job_id, optional_params \\ [], opts \\ [])
View SourceSpecs
dataflow_projects_locations_jobs_get_metrics( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataflow.V1b3.Model.JobMetrics.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.getMetrics
with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.getMetrics
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. -
location
(type:String.t
) - The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. -
job_id
(type:String.t
) - The job to get metrics for. -
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"). -
:startTime
(type:DateTime.t
) - Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dataflow.V1b3.Model.JobMetrics{}}
on success -
{:error, info}
on failure