Show / Hide Table of Contents

Class ProjectsResource.HistoriesResource.ExecutionsResource.StepsResource.PerfSampleSeriesResource.SamplesResource.ListRequest

Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListPerfSamplesResponse>
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>
ProjectsResource.HistoriesResource.ExecutionsResource.StepsResource.PerfSampleSeriesResource.SamplesResource.ListRequest
Implements
IClientServiceRequest<ListPerfSamplesResponse>
IClientServiceRequest
Inherited Members
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.Xgafv
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.AccessToken
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.Alt
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.Callback
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.Fields
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.Key
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.OauthToken
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.PrettyPrint
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.QuotaUser
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.UploadType
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.UploadProtocol
ClientServiceRequest<ListPerfSamplesResponse>.Execute()
ClientServiceRequest<ListPerfSamplesResponse>.ExecuteAsStream()
ClientServiceRequest<ListPerfSamplesResponse>.ExecuteAsync()
ClientServiceRequest<ListPerfSamplesResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListPerfSamplesResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListPerfSamplesResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListPerfSamplesResponse>.CreateRequest(bool?)
ClientServiceRequest<ListPerfSamplesResponse>.GenerateRequestUri()
ClientServiceRequest<ListPerfSamplesResponse>.GetBody()
ClientServiceRequest<ListPerfSamplesResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListPerfSamplesResponse>.ETagAction
ClientServiceRequest<ListPerfSamplesResponse>.ModifyRequest
ClientServiceRequest<ListPerfSamplesResponse>.ValidateParameters
ClientServiceRequest<ListPerfSamplesResponse>.ApiVersion
ClientServiceRequest<ListPerfSamplesResponse>.RequestParameters
ClientServiceRequest<ListPerfSamplesResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.ToolResults.v1beta3
Assembly: Google.Apis.ToolResults.v1beta3.dll
Syntax
public class ProjectsResource.HistoriesResource.ExecutionsResource.StepsResource.PerfSampleSeriesResource.SamplesResource.ListRequest : ToolResultsBaseServiceRequest<ListPerfSamplesResponse>, IClientServiceRequest<ListPerfSamplesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string, string, string, string, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string projectId, string historyId, string executionId, string stepId, string sampleSeriesId)
Parameters
Type Name Description
IClientService service
string projectId
string historyId
string executionId
string stepId
string sampleSeriesId

Properties

ExecutionId

A tool results execution ID.

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

HistoryId

A tool results history ID.

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListPerfSamplesResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListPerfSamplesResponse>.MethodName

PageSize

The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000

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

PageToken

Optional, the next_page_token returned in the previous response

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

ProjectId

The cloud project

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListPerfSamplesResponse>.RestPath

SampleSeriesId

A sample series id

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

StepId

A tool results step ID.

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
ToolResultsBaseServiceRequest<ListPerfSamplesResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX