ListTracesRequest
class ListTracesRequest extends Message
The request message for the ListTraces method. All fields are required
unless specified.
Protobuf type Google\Devtools\Cloudtrace\V1\ListTracesRequest
Methods
No description
ID of the Cloud project where the trace data is stored.
ID of the Cloud project where the trace data is stored.
Type of data returned for traces in the list. Optional. Default is
MINIMAL.
Type of data returned for traces in the list. Optional. Default is
MINIMAL.
Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.
Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.
Token identifying the page of results to return. If provided, use the
value of the next_page_token field from a previous request. Optional.
Token identifying the page of results to return. If provided, use the
value of the next_page_token field from a previous request. Optional.
End of the time interval (inclusive) during which the trace data was collected from the application.
End of the time interval (inclusive) during which the trace data was collected from the application.
Start of the time interval (inclusive) during which the trace data was collected from the application.
Start of the time interval (inclusive) during which the trace data was collected from the application.
An optional filter for the request.
An optional filter for the request.
Field used to sort the returned traces. Optional.
Field used to sort the returned traces. Optional.
Details
at line 83
__construct()
at line 94
string
getProjectId()
ID of the Cloud project where the trace data is stored.
Generated from protobuf field string project_id = 1;
at line 105
setProjectId(string $var)
ID of the Cloud project where the trace data is stored.
Generated from protobuf field string project_id = 1;
at line 118
int
getView()
Type of data returned for traces in the list. Optional. Default is
MINIMAL.
Generated from protobuf field .google.devtools.cloudtrace.v1.ListTracesRequest.ViewType view = 2;
at line 130
setView(int $var)
Type of data returned for traces in the list. Optional. Default is
MINIMAL.
Generated from protobuf field .google.devtools.cloudtrace.v1.ListTracesRequest.ViewType view = 2;
at line 144
int
getPageSize()
Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.
Generated from protobuf field int32 page_size = 3;
at line 157
setPageSize(int $var)
Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.
Generated from protobuf field int32 page_size = 3;
at line 170
string
getPageToken()
Token identifying the page of results to return. If provided, use the
value of the next_page_token field from a previous request. Optional.
Generated from protobuf field string page_token = 4;
at line 182
setPageToken(string $var)
Token identifying the page of results to return. If provided, use the
value of the next_page_token field from a previous request. Optional.
Generated from protobuf field string page_token = 4;
at line 195
Timestamp
getStartTime()
End of the time interval (inclusive) during which the trace data was collected from the application.
Generated from protobuf field .google.protobuf.Timestamp start_time = 5;
at line 207
setStartTime(Timestamp $var)
End of the time interval (inclusive) during which the trace data was collected from the application.
Generated from protobuf field .google.protobuf.Timestamp start_time = 5;
at line 220
Timestamp
getEndTime()
Start of the time interval (inclusive) during which the trace data was collected from the application.
Generated from protobuf field .google.protobuf.Timestamp end_time = 6;
at line 232
setEndTime(Timestamp $var)
Start of the time interval (inclusive) during which the trace data was collected from the application.
Generated from protobuf field .google.protobuf.Timestamp end_time = 6;
at line 244
string
getFilter()
An optional filter for the request.
Generated from protobuf field string filter = 7;
at line 255
setFilter(string $var)
An optional filter for the request.
Generated from protobuf field string filter = 7;
at line 276
string
getOrderBy()
Field used to sort the returned traces. Optional.
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.
Generated from protobuf field string order_by = 8;
at line 296
setOrderBy(string $var)
Field used to sort the returned traces. Optional.
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.
Generated from protobuf field string order_by = 8;