Class ProjectsResource.LocationsResource.JobsResource.ListRequest

List the jobs of a project. To list the jobs of a project in a region, we recommend using projects.locations.jobs.list with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use projects.jobs.aggregated. Using projects.jobs.list is not recommended, because you can only get the list of jobs that are running in us-central1. projects.locations.jobs.list and projects.jobs.list support filtering the list of jobs by name. Filtering by name isn't supported by projects.jobs.aggregated. # IAM Permissions Requires the dataflow.jobs.list permission on the project.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListJobsResponse>
DataflowBaseServiceRequest<ListJobsResponse>
ProjectsResource.LocationsResource.JobsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Dataflow.v1b3
Assembly: Google.Apis.Dataflow.v1b3.dll
Syntax
public class ProjectsResource.LocationsResource.JobsResource.ListRequest : DataflowBaseServiceRequest<ListJobsResponse>, IClientServiceRequest<ListJobsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string, string)

Constructs a new List request.

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

Properties

CreateTimeRangeEndTime

object representation of CreateTimeRangeEndTimeRaw.

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

CreateTimeRangeEndTimeDateTimeOffset

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

CreateTimeRangeEndTimeRaw

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

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

CreateTimeRangeStartTime

object representation of CreateTimeRangeStartTimeRaw.

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

CreateTimeRangeStartTimeDateTimeOffset

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

CreateTimeRangeStartTimeRaw

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

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

Filter

The kind of filter to use.

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.JobsResource.ListRequest.FilterEnum? Filter { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.JobsResource.ListRequest.FilterEnum?

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

Location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

Declaration
[RequestParameter("location", RequestParameterType.Path)]
public virtual string Location { get; }
Property Value
Type Description
string

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Name

Optional. The job name.

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

PageSize

If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.

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

PageToken

Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

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

ProjectId

The project which owns the jobs.

Declaration
[RequestParameter("projectId", RequestParameterType.Path)]
public virtual string ProjectId { get; }
Property Value
Type Description
string

RegionalFanoutRequested

Optional.

Declaration
[RequestParameter("regionalFanoutRequested", RequestParameterType.Query)]
public virtual bool? RegionalFanoutRequested { get; set; }
Property Value
Type Description
bool?

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

TerminationTimeRangeEndTime

object representation of TerminationTimeRangeEndTimeRaw.

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

TerminationTimeRangeEndTimeDateTimeOffset

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

TerminationTimeRangeEndTimeRaw

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

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

TerminationTimeRangeStartTime

object representation of TerminationTimeRangeStartTimeRaw.

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

TerminationTimeRangeStartTimeDateTimeOffset

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

TerminationTimeRangeStartTimeRaw

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

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

View

Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.JobsResource.ListRequest.ViewEnum? View { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.JobsResource.ListRequest.ViewEnum?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements