Copyright	(c) 2015-2025 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]> Toni Cebrián <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics

Contents

Resource
- Constructing a Request

Description

Request the job status. To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.

See: Dataflow API Reference for dataflow.projects.locations.jobs.getMetrics.

Synopsis

type DataflowProjectsLocationsJobsGetMetricsResource = "v1b3" :> ("projects" :> (Capture "projectId" Text :> ("locations" :> (Capture "location" Text :> ("jobs" :> (Capture "jobId" Text :> ("metrics" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "startTime" DateTime :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] JobMetrics))))))))))))))
data DataflowProjectsLocationsJobsGetMetrics = DataflowProjectsLocationsJobsGetMetrics {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- jobId :: Text
- location :: Text
- projectId :: Text
- startTime :: Maybe DateTime
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newDataflowProjectsLocationsJobsGetMetrics :: Text -> Text -> Text -> DataflowProjectsLocationsJobsGetMetrics

Resource

type DataflowProjectsLocationsJobsGetMetricsResource = "v1b3" :> ("projects" :> (Capture "projectId" Text :> ("locations" :> (Capture "location" Text :> ("jobs" :> (Capture "jobId" Text :> ("metrics" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "startTime" DateTime :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] JobMetrics)))))))))))))) Source #

A resource alias for dataflow.projects.locations.jobs.getMetrics method which the DataflowProjectsLocationsJobsGetMetrics request conforms to.

Constructing a Request

data DataflowProjectsLocationsJobsGetMetrics Source #

Request the job status. To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.

See: newDataflowProjectsLocationsJobsGetMetrics smart constructor.

Constructors

DataflowProjectsLocationsJobsGetMetrics

Fields

xgafv :: Maybe Xgafv
V1 error format.
accessToken :: Maybe Text
OAuth access token.
callback :: Maybe Text
JSONP
jobId :: Text
The job to get metrics for.
location :: Text
The regional endpoint that contains the job specified by job_id.
projectId :: Text
A project id.
startTime :: Maybe DateTime
Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.
uploadType :: Maybe Text
Legacy upload protocol for media (e.g. "media", "multipart").
uploadProtocol :: Maybe Text
Upload protocol for media (e.g. "raw", "multipart").

Instances

Instances details

Generic DataflowProjectsLocationsJobsGetMetrics Source #

Instance details

Defined in Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics

Associated Types

type Rep DataflowProjectsLocationsJobsGetMetrics

Instance details

Defined in Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics

Methods

from :: DataflowProjectsLocationsJobsGetMetrics -> Rep DataflowProjectsLocationsJobsGetMetrics x #

to :: Rep DataflowProjectsLocationsJobsGetMetrics x -> DataflowProjectsLocationsJobsGetMetrics #

Show DataflowProjectsLocationsJobsGetMetrics Source #

Instance details

Defined in Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics

Methods

showsPrec :: Int -> DataflowProjectsLocationsJobsGetMetrics -> ShowS #

show :: DataflowProjectsLocationsJobsGetMetrics -> String #

showList :: [DataflowProjectsLocationsJobsGetMetrics] -> ShowS #

Eq DataflowProjectsLocationsJobsGetMetrics Source #

Instance details

Defined in Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics

Methods

(==) :: DataflowProjectsLocationsJobsGetMetrics -> DataflowProjectsLocationsJobsGetMetrics -> Bool #

(/=) :: DataflowProjectsLocationsJobsGetMetrics -> DataflowProjectsLocationsJobsGetMetrics -> Bool #

GoogleRequest DataflowProjectsLocationsJobsGetMetrics Source #

Instance details

Defined in Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics

Associated Types

type Rs DataflowProjectsLocationsJobsGetMetrics
Instance details Defined in Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics type Rs DataflowProjectsLocationsJobsGetMetrics = JobMetrics
type Scopes DataflowProjectsLocationsJobsGetMetrics
Instance details Defined in Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics type Scopes DataflowProjectsLocationsJobsGetMetrics = '[CloudPlatform'FullControl, Compute'FullControl]

Methods

requestClient :: DataflowProjectsLocationsJobsGetMetrics -> GClient (Rs DataflowProjectsLocationsJobsGetMetrics) #

type Rep DataflowProjectsLocationsJobsGetMetrics Source #

Instance details

Defined in Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics

type Rs DataflowProjectsLocationsJobsGetMetrics Source #

Instance details

Defined in Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics

type Rs DataflowProjectsLocationsJobsGetMetrics = JobMetrics

type Scopes DataflowProjectsLocationsJobsGetMetrics Source #

Instance details

Defined in Gogol.Dataflow.Projects.Locations.Jobs.GetMetrics

type Scopes DataflowProjectsLocationsJobsGetMetrics = '[CloudPlatform'FullControl, Compute'FullControl]

newDataflowProjectsLocationsJobsGetMetrics Source #

Arguments

:: Text	The job to get metrics for. See `jobId`.
-> Text	The regional endpoint that contains the job specified by job_id. See `location`.
-> Text	A project id. See `projectId`.
-> DataflowProjectsLocationsJobsGetMetrics

Creates a value of DataflowProjectsLocationsJobsGetMetrics with the minimum fields required to make a request.