Class ProjectsResource.JobsResource.GetMetricsRequest
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
.
Inheritance
Inherited Members
Namespace: Google.Apis.Dataflow.v1b3
Assembly: Google.Apis.Dataflow.v1b3.dll
Syntax
public class ProjectsResource.JobsResource.GetMetricsRequest : DataflowBaseServiceRequest<JobMetrics>, IClientServiceRequest<JobMetrics>, IClientServiceRequest
Constructors
GetMetricsRequest(IClientService, string, string)
Constructs a new GetMetrics request.
Declaration
public GetMetricsRequest(IClientService service, string projectId, string jobId)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | projectId | |
string | jobId |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
JobId
The job to get metrics for.
Declaration
[RequestParameter("jobId", RequestParameterType.Path)]
public virtual string JobId { get; }
Property Value
Type | Description |
---|---|
string |
Location
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
Declaration
[RequestParameter("location", RequestParameterType.Query)]
public virtual string Location { get; set; }
Property Value
Type | Description |
---|---|
string |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
ProjectId
A project id.
Declaration
[RequestParameter("projectId", RequestParameterType.Path)]
public virtual string ProjectId { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
StartTime
object representation of StartTimeRaw.
Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type | Description |
---|---|
object |
StartTimeDateTimeOffset
Declaration
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
StartTimeRaw
String representation of StartTimeDateTimeOffset, formatted for inclusion in the HTTP request.
Declaration
[RequestParameter("startTime", RequestParameterType.Query)]
public virtual string StartTimeRaw { get; }
Property Value
Type | Description |
---|---|
string |
Methods
InitParameters()
Initializes GetMetrics parameter list.
Declaration
protected override void InitParameters()