Show / Hide Table of Contents

Class ProjectsResource.JobsResource.MessagesResource.ListRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListJobMessagesResponse>
DataflowBaseServiceRequest<ListJobMessagesResponse>
ProjectsResource.JobsResource.MessagesResource.ListRequest
Implements
IClientServiceRequest<ListJobMessagesResponse>
IClientServiceRequest
Inherited Members
DataflowBaseServiceRequest<ListJobMessagesResponse>.Xgafv
DataflowBaseServiceRequest<ListJobMessagesResponse>.AccessToken
DataflowBaseServiceRequest<ListJobMessagesResponse>.Alt
DataflowBaseServiceRequest<ListJobMessagesResponse>.Callback
DataflowBaseServiceRequest<ListJobMessagesResponse>.Fields
DataflowBaseServiceRequest<ListJobMessagesResponse>.Key
DataflowBaseServiceRequest<ListJobMessagesResponse>.OauthToken
DataflowBaseServiceRequest<ListJobMessagesResponse>.PrettyPrint
DataflowBaseServiceRequest<ListJobMessagesResponse>.QuotaUser
DataflowBaseServiceRequest<ListJobMessagesResponse>.UploadType
DataflowBaseServiceRequest<ListJobMessagesResponse>.UploadProtocol
ClientServiceRequest<ListJobMessagesResponse>.Execute()
ClientServiceRequest<ListJobMessagesResponse>.ExecuteAsStream()
ClientServiceRequest<ListJobMessagesResponse>.ExecuteAsync()
ClientServiceRequest<ListJobMessagesResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListJobMessagesResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListJobMessagesResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListJobMessagesResponse>.CreateRequest(bool?)
ClientServiceRequest<ListJobMessagesResponse>.GenerateRequestUri()
ClientServiceRequest<ListJobMessagesResponse>.GetBody()
ClientServiceRequest<ListJobMessagesResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListJobMessagesResponse>.ETagAction
ClientServiceRequest<ListJobMessagesResponse>.ModifyRequest
ClientServiceRequest<ListJobMessagesResponse>.ValidateParameters
ClientServiceRequest<ListJobMessagesResponse>.ApiVersion
ClientServiceRequest<ListJobMessagesResponse>.RequestParameters
ClientServiceRequest<ListJobMessagesResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dataflow.v1b3
Assembly: Google.Apis.Dataflow.v1b3.dll
Syntax
public class ProjectsResource.JobsResource.MessagesResource.ListRequest : DataflowBaseServiceRequest<ListJobMessagesResponse>, IClientServiceRequest<ListJobMessagesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string projectId, string jobId)
Parameters
Type Name Description
IClientService service
string projectId
string jobId

Properties

EndTime

object representation of EndTimeRaw.

Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

Declaration
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

String representation of EndTimeDateTimeOffset, formatted for inclusion in the HTTP request.

Declaration
[RequestParameter("endTime", RequestParameterType.Query)]
public virtual string EndTimeRaw { get; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListJobMessagesResponse>.HttpMethod

JobId

The job to get messages about.

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
ClientServiceRequest<ListJobMessagesResponse>.MethodName

MinimumImportance

Filter to only get messages with importance >= level

Declaration
[RequestParameter("minimumImportance", RequestParameterType.Query)]
public virtual ProjectsResource.JobsResource.MessagesResource.ListRequest.MinimumImportanceEnum? MinimumImportance { get; set; }
Property Value
Type Description
ProjectsResource.JobsResource.MessagesResource.ListRequest.MinimumImportanceEnum?

PageSize

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.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

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
ClientServiceRequest<ListJobMessagesResponse>.RestPath

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 List parameter list.

Declaration
protected override void InitParameters()
Overrides
DataflowBaseServiceRequest<ListJobMessagesResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX