Class ProjectsResource.LocationsResource.TransferConfigsResource.RunsResource.ListRequest
Returns information about running and completed transfer runs.
Inheritance
Inherited Members
Namespace: Google.Apis.BigQueryDataTransfer.v1
Assembly: Google.Apis.BigQueryDataTransfer.v1.dll
Syntax
public class ProjectsResource.LocationsResource.TransferConfigsResource.RunsResource.ListRequest : BigQueryDataTransferBaseServiceRequest<ListTransferRunsResponse>, IClientServiceRequest<ListTransferRunsResponse>, 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
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
Page size. The default page size is the maximum value of 1000 results.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
PageToken
Pagination token, which can be used to request a specific page of ListTransferRunsRequest
list results. For multiple-page results, ListTransferRunsResponse outputs a next_page
token, which can be used as the page_token value to request the next page of list results.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Parent
Required. Name of transfer configuration for which transfer runs should be retrieved. If you
are using the regionless method, the location must be US and the name should be in the
following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the
regionalized method, the name should be in the following form: *
projects/{project_id}/locations/{location_id}/transferConfigs/{config_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
RunAttempt
Indicates how run attempts are to be pulled.
Declaration
[RequestParameter("runAttempt", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.TransferConfigsResource.RunsResource.ListRequest.RunAttemptEnum? RunAttempt { get; set; }
Property Value
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.TransferConfigsResource.RunsResource.ListRequest.RunAttemptEnum? |
States
When specified, only transfer runs with requested states are returned.
Declaration
[RequestParameter("states", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.TransferConfigsResource.RunsResource.ListRequest.StatesEnum? States { get; set; }
Property Value
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.TransferConfigsResource.RunsResource.ListRequest.StatesEnum? |
Remarks
Use this property to set a single value for the parameter, or StatesList to set multiple values. Do not set both properties.
StatesList
When specified, only transfer runs with requested states are returned.
Declaration
[RequestParameter("states", RequestParameterType.Query)]
public virtual Repeatable<ProjectsResource.LocationsResource.TransferConfigsResource.RunsResource.ListRequest.StatesEnum> StatesList { get; set; }
Property Value
| Type | Description |
|---|---|
| Repeatable<ProjectsResource.LocationsResource.TransferConfigsResource.RunsResource.ListRequest.StatesEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and States.
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()