ExportTraceServiceResponse
extends Message
in package
Generated from protobuf message <code>opentelemetry.proto.collector.trace.v1.ExportTraceServiceResponse</code>
Table of Contents
Properties
- $partial_success : mixed
- The details of a partially successful export request.
Methods
- __construct() : mixed
- Constructor.
- clearPartialSuccess() : mixed
- getPartialSuccess() : ExportTracePartialSuccess|null
- The details of a partially successful export request.
- hasPartialSuccess() : mixed
- setPartialSuccess() : $this
- The details of a partially successful export request.
Properties
$partial_success
The details of a partially successful export request.
protected
mixed
$partial_success
= null
If the request is only partially accepted
(i.e. when the server accepts only parts of the data and rejects the rest)
the server MUST initialize the partial_success
field and MUST
set the rejected_<signal>
with the number of items it rejected.
Servers MAY also make use of the partial_success
field to convey
warnings/suggestions to senders even when the request was fully accepted.
In such cases, the rejected_<signal>
MUST have a value of 0
and
the error_message
MUST be non-empty.
A partial_success
message with an empty value (rejected_error_message
= "") is equivalent to it not being set/present. Senders
SHOULD interpret it the same way as in the full success case.
Generated from protobuf field .opentelemetry.proto.collector.trace.v1.ExportTracePartialSuccess partial_success = 1;
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
- $data : array<string|int, mixed> = NULL
-
{ Optional. Data for populating the Message object.
@type \Opentelemetry\Proto\Collector\Trace\V1\ExportTracePartialSuccess $partial_success The details of a partially successful export request. If the request is only partially accepted (i.e. when the server accepts only parts of the data and rejects the rest) the server MUST initialize the `partial_success` field and MUST set the `rejected_<signal>` with the number of items it rejected. Servers MAY also make use of the `partial_success` field to convey warnings/suggestions to senders even when the request was fully accepted. In such cases, the `rejected_<signal>` MUST have a value of `0` and the `error_message` MUST be non-empty. A `partial_success` message with an empty value (rejected_<signal> = 0 and `error_message` = "") is equivalent to it not being set/present. Senders SHOULD interpret it the same way as in the full success case.
}
clearPartialSuccess()
public
clearPartialSuccess() : mixed
getPartialSuccess()
The details of a partially successful export request.
public
getPartialSuccess() : ExportTracePartialSuccess|null
If the request is only partially accepted
(i.e. when the server accepts only parts of the data and rejects the rest)
the server MUST initialize the partial_success
field and MUST
set the rejected_<signal>
with the number of items it rejected.
Servers MAY also make use of the partial_success
field to convey
warnings/suggestions to senders even when the request was fully accepted.
In such cases, the rejected_<signal>
MUST have a value of 0
and
the error_message
MUST be non-empty.
A partial_success
message with an empty value (rejected_error_message
= "") is equivalent to it not being set/present. Senders
SHOULD interpret it the same way as in the full success case.
Generated from protobuf field .opentelemetry.proto.collector.trace.v1.ExportTracePartialSuccess partial_success = 1;
Return values
ExportTracePartialSuccess|nullhasPartialSuccess()
public
hasPartialSuccess() : mixed
setPartialSuccess()
The details of a partially successful export request.
public
setPartialSuccess(ExportTracePartialSuccess $var) : $this
If the request is only partially accepted
(i.e. when the server accepts only parts of the data and rejects the rest)
the server MUST initialize the partial_success
field and MUST
set the rejected_<signal>
with the number of items it rejected.
Servers MAY also make use of the partial_success
field to convey
warnings/suggestions to senders even when the request was fully accepted.
In such cases, the rejected_<signal>
MUST have a value of 0
and
the error_message
MUST be non-empty.
A partial_success
message with an empty value (rejected_error_message
= "") is equivalent to it not being set/present. Senders
SHOULD interpret it the same way as in the full success case.
Generated from protobuf field .opentelemetry.proto.collector.trace.v1.ExportTracePartialSuccess partial_success = 1;
Parameters
- $var : ExportTracePartialSuccess