Documentation

Google_Service_Tracing_Resource_ProjectsTraces extends Google_Service_Resource
in package

The "traces" collection of methods.

Typical usage is: $tracingService = new Google_Service_Tracing(...); $traces = $tracingService->traces;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
batchWrite()  : Google_Service_Tracing_TracingEmpty
Sends new spans to Stackdriver Trace or updates existing traces. If the name of a trace that you send matches that of an existing trace, new spans are added to the existing trace. Attempt to update existing spans results undefined behavior. If the name does not match, a new trace is created with given set of spans. (traces.batchWrite)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
listProjectsTraces()  : Google_Service_Tracing_ListTracesResponse
Returns of a list of traces that match the specified filter conditions.
listSpans()  : Google_Service_Tracing_ListSpansResponse
Returns a list of spans within a trace. (traces.listSpans)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

batchWrite()

Sends new spans to Stackdriver Trace or updates existing traces. If the name of a trace that you send matches that of an existing trace, new spans are added to the existing trace. Attempt to update existing spans results undefined behavior. If the name does not match, a new trace is created with given set of spans. (traces.batchWrite)

public batchWrite(string $name, Google_Service_Tracing_BatchWriteSpansRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Tracing_TracingEmpty
Parameters
$name : string

Name of the project where the spans belong to. Format is projects/PROJECT_ID.

$postBody : Google_Service_Tracing_BatchWriteSpansRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Tracing_TracingEmpty —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

listProjectsTraces()

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

public listProjectsTraces(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Tracing_ListTracesResponse

(traces.listProjectsTraces)

Parameters
$parent : string

ID of the Cloud project where the trace data is stored which is projects/PROJECT_ID.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter An optional filter for the request. Example: version_label_key:a some_label:some_label_key returns traces from version a and has some_label with some_label_key.

opt_param

string endTime End of the time interval (inclusive) during which the trace data was collected from the application.

opt_param

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

opt_param

string startTime Start of the time interval (inclusive) during which the trace data was collected from the application.

opt_param

int pageSize 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.

opt_param

string orderBy 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.

Return values
Google_Service_Tracing_ListTracesResponse —

listSpans()

Returns a list of spans within a trace. (traces.listSpans)

public listSpans(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Tracing_ListSpansResponse
Parameters
$parent : string

ID of the trace for which to list child spans. Format is projects/PROJECT_ID/traces/TRACE_ID.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Token identifying the page of results to return. If provided, use the value of the nextPageToken field from a previous request. Optional.

Return values
Google_Service_Tracing_ListSpansResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results