Class ProcessesResource.ListScriptProcessesRequest
List information about a script's executed processes, 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.ListScriptProcessesRequest : ScriptBaseServiceRequest<ListScriptProcessesResponse>, IClientServiceRequest<ListScriptProcessesResponse>, IClientServiceRequest
Constructors
ListScriptProcessesRequest(IClientService)
Constructs a new ListScriptProcesses request.
Declaration
public ListScriptProcessesRequest(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
ScriptId
The script ID of the project whose processes are listed.
Declaration
[RequestParameter("scriptId", RequestParameterType.Query)]
public virtual string ScriptId { get; set; }
Property Value
Type | Description |
---|---|
string |
ScriptProcessFilterDeploymentId
Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
Declaration
[RequestParameter("scriptProcessFilter.deploymentId", RequestParameterType.Query)]
public virtual string ScriptProcessFilterDeploymentId { get; set; }
Property Value
Type | Description |
---|---|
string |
ScriptProcessFilterEndTime
object representation of ScriptProcessFilterEndTimeRaw.
Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use ScriptProcessFilterEndTimeDateTimeOffset instead.")]
public virtual object ScriptProcessFilterEndTime { get; set; }
Property Value
Type | Description |
---|---|
object |
ScriptProcessFilterEndTimeDateTimeOffset
Declaration
public virtual DateTimeOffset? ScriptProcessFilterEndTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
ScriptProcessFilterEndTimeRaw
String representation of ScriptProcessFilterEndTimeDateTimeOffset, formatted for inclusion in the HTTP request.
Declaration
[RequestParameter("scriptProcessFilter.endTime", RequestParameterType.Query)]
public virtual string ScriptProcessFilterEndTimeRaw { get; }
Property Value
Type | Description |
---|---|
string |
ScriptProcessFilterFunctionName
Optional field used to limit returned processes to those originating from a script function with the given function name.
Declaration
[RequestParameter("scriptProcessFilter.functionName", RequestParameterType.Query)]
public virtual string ScriptProcessFilterFunctionName { get; set; }
Property Value
Type | Description |
---|---|
string |
ScriptProcessFilterStartTime
object representation of ScriptProcessFilterStartTimeRaw.
Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use ScriptProcessFilterStartTimeDateTimeOffset instead.")]
public virtual object ScriptProcessFilterStartTime { get; set; }
Property Value
Type | Description |
---|---|
object |
ScriptProcessFilterStartTimeDateTimeOffset
Declaration
public virtual DateTimeOffset? ScriptProcessFilterStartTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
ScriptProcessFilterStartTimeRaw
String representation of ScriptProcessFilterStartTimeDateTimeOffset, formatted for inclusion in the HTTP request.
Declaration
[RequestParameter("scriptProcessFilter.startTime", RequestParameterType.Query)]
public virtual string ScriptProcessFilterStartTimeRaw { get; }
Property Value
Type | Description |
---|---|
string |
ScriptProcessFilterStatuses
Optional field used to limit returned processes to those having one of the specified process statuses.
Declaration
[RequestParameter("scriptProcessFilter.statuses", RequestParameterType.Query)]
public virtual ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterStatusesEnum? ScriptProcessFilterStatuses { get; set; }
Property Value
Type | Description |
---|---|
ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterStatusesEnum? |
Remarks
Use this property to set a single value for the parameter, or ScriptProcessFilterStatusesList to set multiple values. Do not set both properties.
ScriptProcessFilterStatusesList
Optional field used to limit returned processes to those having one of the specified process statuses.
Declaration
[RequestParameter("scriptProcessFilter.statuses", RequestParameterType.Query)]
public virtual Repeatable<ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterStatusesEnum> ScriptProcessFilterStatusesList { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterStatusesEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and ScriptProcessFilterStatuses.
ScriptProcessFilterTypes
Optional field used to limit returned processes to those having one of the specified process types.
Declaration
[RequestParameter("scriptProcessFilter.types", RequestParameterType.Query)]
public virtual ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterTypesEnum? ScriptProcessFilterTypes { get; set; }
Property Value
Type | Description |
---|---|
ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterTypesEnum? |
Remarks
Use this property to set a single value for the parameter, or ScriptProcessFilterTypesList to set multiple values. Do not set both properties.
ScriptProcessFilterTypesList
Optional field used to limit returned processes to those having one of the specified process types.
Declaration
[RequestParameter("scriptProcessFilter.types", RequestParameterType.Query)]
public virtual Repeatable<ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterTypesEnum> ScriptProcessFilterTypesList { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterTypesEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and ScriptProcessFilterTypes.
ScriptProcessFilterUserAccessLevels
Optional field used to limit returned processes to those having one of the specified user access levels.
Declaration
[RequestParameter("scriptProcessFilter.userAccessLevels", RequestParameterType.Query)]
public virtual ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterUserAccessLevelsEnum? ScriptProcessFilterUserAccessLevels { get; set; }
Property Value
Type | Description |
---|---|
ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterUserAccessLevelsEnum? |
Remarks
Use this property to set a single value for the parameter, or ScriptProcessFilterUserAccessLevelsList to set multiple values. Do not set both properties.
ScriptProcessFilterUserAccessLevelsList
Optional field used to limit returned processes to those having one of the specified user access levels.
Declaration
[RequestParameter("scriptProcessFilter.userAccessLevels", RequestParameterType.Query)]
public virtual Repeatable<ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterUserAccessLevelsEnum> ScriptProcessFilterUserAccessLevelsList { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<ProcessesResource.ListScriptProcessesRequest.ScriptProcessFilterUserAccessLevelsEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and ScriptProcessFilterUserAccessLevels.
Methods
InitParameters()
Initializes ListScriptProcesses parameter list.
Declaration
protected override void InitParameters()