Class ProjectsResource.TracesResource.ListRequest

Returns a list of traces that match the specified filter conditions.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListTracesResponse>
CloudTraceBaseServiceRequest<ListTracesResponse>
ProjectsResource.TracesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudTrace.v1
Assembly: Google.Apis.CloudTrace.v1.dll
Syntax
public class ProjectsResource.TracesResource.ListRequest : CloudTraceBaseServiceRequest<ListTracesResponse>, IClientServiceRequest<ListTracesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string projectId)
Parameters
Type Name Description
IClientService service
string projectId

Properties

EndTime

object representation of EndTimeRaw.

Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

Declaration
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

String representation of EndTimeDateTimeOffset, formatted for inclusion in the HTTP request.

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

Filter

Optional. A filter against labels for the request. By default, searches use prefix matching. To specify exact match, prepend a plus symbol (+) to the search term. Multiple terms are ANDed. Syntax: * root:NAME_PREFIX or NAME_PREFIX: Return traces where any root span starts with NAME_PREFIX. * +root:NAME or +NAME: Return traces where any root span's name is exactly NAME. * span:NAME_PREFIX: Return traces where any span starts with NAME_PREFIX. * +span:NAME: Return traces where any span's name is exactly NAME. * latency:DURATION: Return traces whose overall latency is greater or equal to than DURATION. Accepted units are nanoseconds (ns), milliseconds (ms), and seconds (s). Default is ms. For example, latency:24ms returns traces whose overall latency is greater than or equal to 24 milliseconds. * label:LABEL_KEY: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values). * LABEL_KEY:VALUE_PREFIX: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with VALUE_PREFIX. Both a key and a value must be specified. * +LABEL_KEY:VALUE: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified. * method:VALUE: Equivalent to /http/method:VALUE. * url:VALUE: Equivalent to /http/url:VALUE.

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

OrderBy

Optional. Field used to sort the returned traces. Can be one of the following: * trace_id * name (name field of root span in the trace) * duration (difference between end_time and start_time fields of the root span) * start (start_time field of the root span) Descending order can be specified by appending desc to the sort field (for example, name desc). Only one sort field is permitted.

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

PageSize

Optional. Maximum number of traces to return. If not specified or &lt;= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size.

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

PageToken

Token identifying the page of results to return. If provided, use the value of the next_page_token field from a previous request.

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

ProjectId

Required. ID of the Cloud project where the trace data is stored.

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

StartTime

object representation of StartTimeRaw.

Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

Declaration
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

String representation of StartTimeDateTimeOffset, formatted for inclusion in the HTTP request.

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

View

Optional. Type of data returned for traces in the list. Default is MINIMAL.

Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual ProjectsResource.TracesResource.ListRequest.ViewEnum? View { get; set; }
Property Value
Type Description
ProjectsResource.TracesResource.ListRequest.ViewEnum?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements