Class ProcessesResource.ListRequest
List information about processes made by or on behalf of a user, such as process type and current status.
Inheritance
Inherited Members
Namespace: Google.Apis.Script.v1
Assembly: Google.Apis.Script.v1.dll
Syntax
public class ProcessesResource.ListRequest : ScriptBaseServiceRequest<ListUserProcessesResponse>, IClientServiceRequest<ListUserProcessesResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService)
Constructs a new List request.
Declaration
public ListRequest(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
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
The maximum number of returned processes per page of results. Defaults to 50.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
The token for continuing a previous list request on the next page. This should be set to the value of
nextPageToken
from a previous response.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
UserProcessFilterDeploymentId
Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
Declaration
[RequestParameter("userProcessFilter.deploymentId", RequestParameterType.Query)]
public virtual string UserProcessFilterDeploymentId { get; set; }
Property Value
Type | Description |
---|---|
string |
UserProcessFilterEndTime
object representation of UserProcessFilterEndTimeRaw.
Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use UserProcessFilterEndTimeDateTimeOffset instead.")]
public virtual object UserProcessFilterEndTime { get; set; }
Property Value
Type | Description |
---|---|
object |
UserProcessFilterEndTimeDateTimeOffset
Declaration
public virtual DateTimeOffset? UserProcessFilterEndTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
UserProcessFilterEndTimeRaw
String representation of UserProcessFilterEndTimeDateTimeOffset, formatted for inclusion in the HTTP request.
Declaration
[RequestParameter("userProcessFilter.endTime", RequestParameterType.Query)]
public virtual string UserProcessFilterEndTimeRaw { get; }
Property Value
Type | Description |
---|---|
string |
UserProcessFilterFunctionName
Optional field used to limit returned processes to those originating from a script function with the given function name.
Declaration
[RequestParameter("userProcessFilter.functionName", RequestParameterType.Query)]
public virtual string UserProcessFilterFunctionName { get; set; }
Property Value
Type | Description |
---|---|
string |
UserProcessFilterProjectName
Optional field used to limit returned processes to those originating from projects with project names containing a specific string.
Declaration
[RequestParameter("userProcessFilter.projectName", RequestParameterType.Query)]
public virtual string UserProcessFilterProjectName { get; set; }
Property Value
Type | Description |
---|---|
string |
UserProcessFilterScriptId
Optional field used to limit returned processes to those originating from projects with a specific script ID.
Declaration
[RequestParameter("userProcessFilter.scriptId", RequestParameterType.Query)]
public virtual string UserProcessFilterScriptId { get; set; }
Property Value
Type | Description |
---|---|
string |
UserProcessFilterStartTime
object representation of UserProcessFilterStartTimeRaw.
Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use UserProcessFilterStartTimeDateTimeOffset instead.")]
public virtual object UserProcessFilterStartTime { get; set; }
Property Value
Type | Description |
---|---|
object |
UserProcessFilterStartTimeDateTimeOffset
Declaration
public virtual DateTimeOffset? UserProcessFilterStartTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
UserProcessFilterStartTimeRaw
String representation of UserProcessFilterStartTimeDateTimeOffset, formatted for inclusion in the HTTP request.
Declaration
[RequestParameter("userProcessFilter.startTime", RequestParameterType.Query)]
public virtual string UserProcessFilterStartTimeRaw { get; }
Property Value
Type | Description |
---|---|
string |
UserProcessFilterStatuses
Optional field used to limit returned processes to those having one of the specified process statuses.
Declaration
[RequestParameter("userProcessFilter.statuses", RequestParameterType.Query)]
public virtual ProcessesResource.ListRequest.UserProcessFilterStatusesEnum? UserProcessFilterStatuses { get; set; }
Property Value
Type | Description |
---|---|
ProcessesResource.ListRequest.UserProcessFilterStatusesEnum? |
Remarks
Use this property to set a single value for the parameter, or UserProcessFilterStatusesList to set multiple values. Do not set both properties.
UserProcessFilterStatusesList
Optional field used to limit returned processes to those having one of the specified process statuses.
Declaration
[RequestParameter("userProcessFilter.statuses", RequestParameterType.Query)]
public virtual Repeatable<ProcessesResource.ListRequest.UserProcessFilterStatusesEnum> UserProcessFilterStatusesList { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<ProcessesResource.ListRequest.UserProcessFilterStatusesEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and UserProcessFilterStatuses.
UserProcessFilterTypes
Optional field used to limit returned processes to those having one of the specified process types.
Declaration
[RequestParameter("userProcessFilter.types", RequestParameterType.Query)]
public virtual ProcessesResource.ListRequest.UserProcessFilterTypesEnum? UserProcessFilterTypes { get; set; }
Property Value
Type | Description |
---|---|
ProcessesResource.ListRequest.UserProcessFilterTypesEnum? |
Remarks
Use this property to set a single value for the parameter, or UserProcessFilterTypesList to set multiple values. Do not set both properties.
UserProcessFilterTypesList
Optional field used to limit returned processes to those having one of the specified process types.
Declaration
[RequestParameter("userProcessFilter.types", RequestParameterType.Query)]
public virtual Repeatable<ProcessesResource.ListRequest.UserProcessFilterTypesEnum> UserProcessFilterTypesList { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<ProcessesResource.ListRequest.UserProcessFilterTypesEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and UserProcessFilterTypes.
UserProcessFilterUserAccessLevels
Optional field used to limit returned processes to those having one of the specified user access levels.
Declaration
[RequestParameter("userProcessFilter.userAccessLevels", RequestParameterType.Query)]
public virtual ProcessesResource.ListRequest.UserProcessFilterUserAccessLevelsEnum? UserProcessFilterUserAccessLevels { get; set; }
Property Value
Type | Description |
---|---|
ProcessesResource.ListRequest.UserProcessFilterUserAccessLevelsEnum? |
Remarks
Use this property to set a single value for the parameter, or UserProcessFilterUserAccessLevelsList to set multiple values. Do not set both properties.
UserProcessFilterUserAccessLevelsList
Optional field used to limit returned processes to those having one of the specified user access levels.
Declaration
[RequestParameter("userProcessFilter.userAccessLevels", RequestParameterType.Query)]
public virtual Repeatable<ProcessesResource.ListRequest.UserProcessFilterUserAccessLevelsEnum> UserProcessFilterUserAccessLevelsList { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<ProcessesResource.ListRequest.UserProcessFilterUserAccessLevelsEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and UserProcessFilterUserAccessLevels.
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()