mdg.engine.proto

Interface Reports.TraceOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Reports.Trace, Reports.Trace.Builder

Enclosing class:

Reports

public static interface Reports.TraceOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Reports.Trace.CachePolicy	getCachePolicy() .mdg.engine.proto.Trace.CachePolicy cache_policy = 18;
Reports.Trace.CachePolicyOrBuilder	getCachePolicyOrBuilder() .mdg.engine.proto.Trace.CachePolicy cache_policy = 18;
java.lang.String	getClientAddress() string client_address = 9;
com.google.protobuf.ByteString	getClientAddressBytes() string client_address = 9;
java.lang.String	getClientName() Note: engineproxy always sets client_name, client_version, and client_address to "none".
com.google.protobuf.ByteString	getClientNameBytes() Note: engineproxy always sets client_name, client_version, and client_address to "none".
java.lang.String	getClientReferenceId() string client_reference_id = 23;
com.google.protobuf.ByteString	getClientReferenceIdBytes() string client_reference_id = 23;
java.lang.String	getClientVersion() string client_version = 8;
com.google.protobuf.ByteString	getClientVersionBytes() string client_version = 8;
Reports.Trace.Details	getDetails() .mdg.engine.proto.Trace.Details details = 6;
Reports.Trace.DetailsOrBuilder	getDetailsOrBuilder() .mdg.engine.proto.Trace.Details details = 6;
long	getDurationNs() High precision duration of the trace; may not equal end_time-start_time (eg, if your machine's clock changed during the trace).
com.google.protobuf.Timestamp	getEndTime() Wallclock time when the trace ended.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Wallclock time when the trace ended.
boolean	getForbiddenOperation() Was this operation forbidden due to lack of safelisting?
boolean	getFullQueryCacheHit() Was this response served from a full query response cache? (In that case the node tree will have no resolvers.)
Reports.Trace.HTTP	getHttp() .mdg.engine.proto.Trace.HTTP http = 10;
Reports.Trace.HTTPOrBuilder	getHttpOrBuilder() .mdg.engine.proto.Trace.HTTP http = 10;
java.lang.String	getLegacySignatureNeedsResigning() Older agents (eg the Go engineproxy) relied to some degree on the Engine backend to run their own semi-compatible implementation of a specific variant of query signatures.
com.google.protobuf.ByteString	getLegacySignatureNeedsResigningBytes() Older agents (eg the Go engineproxy) relied to some degree on the Engine backend to run their own semi-compatible implementation of a specific variant of query signatures.
long	getOriginReportedDurationNs() uint64 origin_reported_duration_ns = 17;
com.google.protobuf.Timestamp	getOriginReportedEndTime() .google.protobuf.Timestamp origin_reported_end_time = 16;
com.google.protobuf.TimestampOrBuilder	getOriginReportedEndTimeOrBuilder() .google.protobuf.Timestamp origin_reported_end_time = 16;
com.google.protobuf.Timestamp	getOriginReportedStartTime() -------------------------------------------------------------- Fields below this line are only set by the old Go engineproxy.
com.google.protobuf.TimestampOrBuilder	getOriginReportedStartTimeOrBuilder() -------------------------------------------------------------- Fields below this line are only set by the old Go engineproxy.
boolean	getPersistedQueryHit() Was this query specified successfully as a persisted query hash?
boolean	getPersistedQueryRegister() Did this query contain both a full query string and a persisted query hash? (This typically means that a previous request was rejected as an unknown persisted query.)
Reports.Trace.QueryPlanNode	getQueryPlan() If this Trace was created by a gateway, this is the query plan, including sub-Traces for federated services.
Reports.Trace.QueryPlanNodeOrBuilder	getQueryPlanOrBuilder() If this Trace was created by a gateway, this is the query plan, including sub-Traces for federated services.
boolean	getRegisteredOperation() Was this operation registered and a part of the safelist?
Reports.Trace.Node	getRoot() A tree containing information about all resolvers run directly by this service, including errors.
Reports.Trace.NodeOrBuilder	getRootOrBuilder() A tree containing information about all resolvers run directly by this service, including errors.
java.lang.String	getSignature() In addition to details.raw_query, we include a "signature" of the query, which can be normalized: for example, you may want to discard aliases, drop unused operations and fragments, sort fields, etc.
com.google.protobuf.ByteString	getSignatureBytes() In addition to details.raw_query, we include a "signature" of the query, which can be normalized: for example, you may want to discard aliases, drop unused operations and fragments, sort fields, etc.
com.google.protobuf.Timestamp	getStartTime() Wallclock time when the trace began.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Wallclock time when the trace began.
boolean	hasCachePolicy() .mdg.engine.proto.Trace.CachePolicy cache_policy = 18;
boolean	hasDetails() .mdg.engine.proto.Trace.Details details = 6;
boolean	hasEndTime() Wallclock time when the trace ended.
boolean	hasHttp() .mdg.engine.proto.Trace.HTTP http = 10;
boolean	hasOriginReportedEndTime() .google.protobuf.Timestamp origin_reported_end_time = 16;
boolean	hasOriginReportedStartTime() -------------------------------------------------------------- Fields below this line are only set by the old Go engineproxy.
boolean	hasQueryPlan() If this Trace was created by a gateway, this is the query plan, including sub-Traces for federated services.
boolean	hasRoot() A tree containing information about all resolvers run directly by this service, including errors.
boolean	hasStartTime() Wallclock time when the trace began.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasStartTime

boolean hasStartTime()

 Wallclock time when the trace began.
 

.google.protobuf.Timestamp start_time = 4;

Returns:

Whether the startTime field is set.

getStartTime

com.google.protobuf.Timestamp getStartTime()

 Wallclock time when the trace began.
 

.google.protobuf.Timestamp start_time = 4;

Returns:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Wallclock time when the trace began.
 

.google.protobuf.Timestamp start_time = 4;

hasEndTime

boolean hasEndTime()

 Wallclock time when the trace ended.
 

.google.protobuf.Timestamp end_time = 3;

Returns:

Whether the endTime field is set.

getEndTime

com.google.protobuf.Timestamp getEndTime()

 Wallclock time when the trace ended.
 

.google.protobuf.Timestamp end_time = 3;

Returns:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 Wallclock time when the trace ended.
 

.google.protobuf.Timestamp end_time = 3;

getDurationNs

long getDurationNs()

 High precision duration of the trace; may not equal end_time-start_time
 (eg, if your machine's clock changed during the trace).
 

uint64 duration_ns = 11;

Returns:

The durationNs.

hasRoot

boolean hasRoot()

 A tree containing information about all resolvers run directly by this
 service, including errors.
 

.mdg.engine.proto.Trace.Node root = 14;

Returns:

Whether the root field is set.

getRoot

Reports.Trace.Node getRoot()

 A tree containing information about all resolvers run directly by this
 service, including errors.
 

.mdg.engine.proto.Trace.Node root = 14;

Returns:

The root.

getRootOrBuilder

Reports.Trace.NodeOrBuilder getRootOrBuilder()

 A tree containing information about all resolvers run directly by this
 service, including errors.
 

.mdg.engine.proto.Trace.Node root = 14;

getSignature

java.lang.String getSignature()

 In addition to details.raw_query, we include a "signature" of the query,
 which can be normalized: for example, you may want to discard aliases, drop
 unused operations and fragments, sort fields, etc. The most important thing
 here is that the signature match the signature in StatsReports. In
 StatsReports signatures show up as the key in the per_query map (with the
 operation name prepended).  The signature should be a valid GraphQL query.
 All traces must have a signature; if this Trace is in a FullTracesReport
 that signature is in the key of traces_per_query rather than in this field.
 Engineproxy provides the signature in legacy_signature_needs_resigning
 instead.
 

string signature = 19;

Returns:

The signature.

getSignatureBytes

com.google.protobuf.ByteString getSignatureBytes()

 In addition to details.raw_query, we include a "signature" of the query,
 which can be normalized: for example, you may want to discard aliases, drop
 unused operations and fragments, sort fields, etc. The most important thing
 here is that the signature match the signature in StatsReports. In
 StatsReports signatures show up as the key in the per_query map (with the
 operation name prepended).  The signature should be a valid GraphQL query.
 All traces must have a signature; if this Trace is in a FullTracesReport
 that signature is in the key of traces_per_query rather than in this field.
 Engineproxy provides the signature in legacy_signature_needs_resigning
 instead.
 

string signature = 19;

Returns:

The bytes for signature.

hasDetails

boolean hasDetails()

.mdg.engine.proto.Trace.Details details = 6;

Returns:

Whether the details field is set.

getDetails

Reports.Trace.Details getDetails()

.mdg.engine.proto.Trace.Details details = 6;

Returns:

The details.

getDetailsOrBuilder

Reports.Trace.DetailsOrBuilder getDetailsOrBuilder()

.mdg.engine.proto.Trace.Details details = 6;

getClientName

java.lang.String getClientName()

 Note: engineproxy always sets client_name, client_version, and client_address to "none".
 apollo-engine-reporting allows for them to be set by the user.
 

string client_name = 7;

Returns:

The clientName.

getClientNameBytes

com.google.protobuf.ByteString getClientNameBytes()

 Note: engineproxy always sets client_name, client_version, and client_address to "none".
 apollo-engine-reporting allows for them to be set by the user.
 

string client_name = 7;

Returns:

The bytes for clientName.

getClientVersion

java.lang.String getClientVersion()

string client_version = 8;

Returns:

The clientVersion.

getClientVersionBytes

com.google.protobuf.ByteString getClientVersionBytes()

string client_version = 8;

Returns:

The bytes for clientVersion.

getClientAddress

java.lang.String getClientAddress()

string client_address = 9;

Returns:

The clientAddress.

getClientAddressBytes

com.google.protobuf.ByteString getClientAddressBytes()

string client_address = 9;

Returns:

The bytes for clientAddress.

getClientReferenceId

java.lang.String getClientReferenceId()

string client_reference_id = 23;

Returns:

The clientReferenceId.

getClientReferenceIdBytes

com.google.protobuf.ByteString getClientReferenceIdBytes()

string client_reference_id = 23;

Returns:

The bytes for clientReferenceId.

hasHttp

boolean hasHttp()

.mdg.engine.proto.Trace.HTTP http = 10;

Returns:

Whether the http field is set.

getHttp

Reports.Trace.HTTP getHttp()

.mdg.engine.proto.Trace.HTTP http = 10;

Returns:

The http.

getHttpOrBuilder

Reports.Trace.HTTPOrBuilder getHttpOrBuilder()

.mdg.engine.proto.Trace.HTTP http = 10;

hasCachePolicy

boolean hasCachePolicy()

.mdg.engine.proto.Trace.CachePolicy cache_policy = 18;

Returns:

Whether the cachePolicy field is set.

getCachePolicy

Reports.Trace.CachePolicy getCachePolicy()

.mdg.engine.proto.Trace.CachePolicy cache_policy = 18;

Returns:

The cachePolicy.

getCachePolicyOrBuilder

Reports.Trace.CachePolicyOrBuilder getCachePolicyOrBuilder()

.mdg.engine.proto.Trace.CachePolicy cache_policy = 18;

hasQueryPlan

boolean hasQueryPlan()

 If this Trace was created by a gateway, this is the query plan, including
 sub-Traces for federated services. Note that the 'root' tree on the
 top-level Trace won't contain any resolvers (though it could contain errors
 that occurred in the gateway itself).
 

.mdg.engine.proto.Trace.QueryPlanNode query_plan = 26;

Returns:

Whether the queryPlan field is set.

getQueryPlan

Reports.Trace.QueryPlanNode getQueryPlan()

 If this Trace was created by a gateway, this is the query plan, including
 sub-Traces for federated services. Note that the 'root' tree on the
 top-level Trace won't contain any resolvers (though it could contain errors
 that occurred in the gateway itself).
 

.mdg.engine.proto.Trace.QueryPlanNode query_plan = 26;

Returns:

The queryPlan.

getQueryPlanOrBuilder

Reports.Trace.QueryPlanNodeOrBuilder getQueryPlanOrBuilder()

 If this Trace was created by a gateway, this is the query plan, including
 sub-Traces for federated services. Note that the 'root' tree on the
 top-level Trace won't contain any resolvers (though it could contain errors
 that occurred in the gateway itself).
 

.mdg.engine.proto.Trace.QueryPlanNode query_plan = 26;

getFullQueryCacheHit

boolean getFullQueryCacheHit()

 Was this response served from a full query response cache?  (In that case
 the node tree will have no resolvers.)
 

bool full_query_cache_hit = 20;

Returns:

The fullQueryCacheHit.

getPersistedQueryHit

boolean getPersistedQueryHit()

 Was this query specified successfully as a persisted query hash?
 

bool persisted_query_hit = 21;

Returns:

The persistedQueryHit.

getPersistedQueryRegister

boolean getPersistedQueryRegister()

 Did this query contain both a full query string and a persisted query hash?
 (This typically means that a previous request was rejected as an unknown
 persisted query.)
 

bool persisted_query_register = 22;

Returns:

The persistedQueryRegister.

getRegisteredOperation

boolean getRegisteredOperation()

 Was this operation registered and a part of the safelist?
 

bool registered_operation = 24;

Returns:

The registeredOperation.

getForbiddenOperation

boolean getForbiddenOperation()

 Was this operation forbidden due to lack of safelisting?
 

bool forbidden_operation = 25;

Returns:

The forbiddenOperation.

hasOriginReportedStartTime

boolean hasOriginReportedStartTime()

 --------------------------------------------------------------
 Fields below this line are only set by the old Go engineproxy.
 

.google.protobuf.Timestamp origin_reported_start_time = 15;

Returns:

Whether the originReportedStartTime field is set.

getOriginReportedStartTime

com.google.protobuf.Timestamp getOriginReportedStartTime()

 --------------------------------------------------------------
 Fields below this line are only set by the old Go engineproxy.
 

.google.protobuf.Timestamp origin_reported_start_time = 15;

Returns:

The originReportedStartTime.

getOriginReportedStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getOriginReportedStartTimeOrBuilder()

 --------------------------------------------------------------
 Fields below this line are only set by the old Go engineproxy.
 

.google.protobuf.Timestamp origin_reported_start_time = 15;

hasOriginReportedEndTime

boolean hasOriginReportedEndTime()

.google.protobuf.Timestamp origin_reported_end_time = 16;

Returns:

Whether the originReportedEndTime field is set.

getOriginReportedEndTime

com.google.protobuf.Timestamp getOriginReportedEndTime()

.google.protobuf.Timestamp origin_reported_end_time = 16;

Returns:

The originReportedEndTime.

getOriginReportedEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getOriginReportedEndTimeOrBuilder()

.google.protobuf.Timestamp origin_reported_end_time = 16;

getOriginReportedDurationNs

long getOriginReportedDurationNs()

uint64 origin_reported_duration_ns = 17;

Returns:

The originReportedDurationNs.

getLegacySignatureNeedsResigning

java.lang.String getLegacySignatureNeedsResigning()

 Older agents (eg the Go engineproxy) relied to some degree on the Engine
 backend to run their own semi-compatible implementation of a specific
 variant of query signatures. The backend does not do this for new agents (which
 set the above 'signature' field). It used to still "re-sign" signatures
 from engineproxy, but we've now simplified the backend to no longer do this.
 Deprecated and ignored in FullTracesReports.
 

string legacy_signature_needs_resigning = 5;

Returns:

The legacySignatureNeedsResigning.

getLegacySignatureNeedsResigningBytes

com.google.protobuf.ByteString getLegacySignatureNeedsResigningBytes()

 Older agents (eg the Go engineproxy) relied to some degree on the Engine
 backend to run their own semi-compatible implementation of a specific
 variant of query signatures. The backend does not do this for new agents (which
 set the above 'signature' field). It used to still "re-sign" signatures
 from engineproxy, but we've now simplified the backend to no longer do this.
 Deprecated and ignored in FullTracesReports.
 

string legacy_signature_needs_resigning = 5;

Returns:

The bytes for legacySignatureNeedsResigning.