Class ProjectsResource.LocationsResource.PipelinesResource.ListRequest
Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Datapipelines.v1
Assembly: Google.Apis.Datapipelines.v1.dll
Syntax
public class ProjectsResource.LocationsResource.PipelinesResource.ListRequest : DatapipelinesBaseServiceRequest<GoogleCloudDatapipelinesV1ListPipelinesResponse>, IClientServiceRequest<GoogleCloudDatapipelinesV1ListPipelinesResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | parent |
Properties
Filter
An expression for filtering the results of the request. If unspecified, all pipelines will be
returned. Multiple filters can be applied and must be comma separated. Fields eligible for
filtering are: + type
: The type of the pipeline (streaming or batch). Allowed values are
ALL
, BATCH
, and STREAMING
. + status
: The activity status of the pipeline. Allowed values
are ALL
, ACTIVE
, ARCHIVED
, and PAUSED
. For example, to limit results to active batch
processing pipelines: type:BATCH,status:ACTIVE
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
PageSize
The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the max limit is yet to be determined by the backend implementation.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
A page token, received from a previous ListPipelines
call. Provide this to retrieve the
subsequent page. When paginating, all other parameters provided to ListPipelines
must match
the call that provided the page token.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
Parent
Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID
.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()