# Class TraceSpan (2.93.0) 2.93.0 (latest) 2.91.0 2.88.0 2.87.0 2.85.0 2.83.0 2.82.0 2.80.0 2.78.0 2.76.0 2.75.0 2.74.0 2.73.0 2.72.0 2.70.0 2.68.0 2.67.0 2.64.0 2.63.0 2.62.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.0 2.55.0 2.54.0 2.53.0 2.52.0 2.51.0 2.49.0 2.48.0 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.28.0 2.27.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.7 2.2.0 2.1.13 public final class TraceSpan extends GeneratedMessage implements TraceSpanOrBuilder A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace. Protobuf type `google.devtools.cloudtrace.v1.TraceSpan` ## Inheritance [Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> [AbstractMessageLite\](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.html) \> [AbstractMessage](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html) \> [GeneratedMessage](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html) \> TraceSpan ## Implements [TraceSpanOrBuilder](https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpanOrBuilder) ## Inherited Members [AbstractMessage.equals(Object)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html#com_google_protobuf_AbstractMessage_equals_java_lang_Object_) [AbstractMessage.findInitializationErrors()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html#com_google_protobuf_AbstractMessage_findInitializationErrors__) [AbstractMessage.getInitializationErrorString()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html#com_google_protobuf_AbstractMessage_getInitializationErrorString__) [AbstractMessage.hashCode()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html#com_google_protobuf_AbstractMessage_hashCode__) [AbstractMessage.hashFields(int,Map\)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html#com_google_protobuf_AbstractMessage_hashFields_int_java_util_Map_com_google_protobuf_Descriptors_FieldDescriptor_java_lang_Object__) [AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html#com_google_protobuf_AbstractMessage_newBuilderForType_com_google_protobuf_AbstractMessage_BuilderParent_) [AbstractMessage.toString()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html#com_google_protobuf_AbstractMessage_toString__) [AbstractMessageLite.\addAll(Iterable\,List\)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.html#com_google_protobuf_AbstractMessageLite__T_addAll_java_lang_Iterable_T__java_util_List___super_T__) [AbstractMessageLite.checkByteStringIsUtf8(ByteString)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.html#com_google_protobuf_AbstractMessageLite_checkByteStringIsUtf8_com_google_protobuf_ByteString_) [AbstractMessageLite.toByteArray()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.html#com_google_protobuf_AbstractMessageLite_toByteArray__) [AbstractMessageLite.toByteString()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.html#com_google_protobuf_AbstractMessageLite_toByteString__) [AbstractMessageLite.writeDelimitedTo(OutputStream)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.html#com_google_protobuf_AbstractMessageLite_writeDelimitedTo_java_io_OutputStream_) [AbstractMessageLite.writeTo(OutputStream)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.html#com_google_protobuf_AbstractMessageLite_writeTo_java_io_OutputStream_) com.google.protobuf.GeneratedMessage.\newFileScopedGeneratedExtension(java.lang.Class\,com.google.protobuf.Message) com.google.protobuf.GeneratedMessage.\newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class\,com.google.protobuf.Message) com.google.protobuf.GeneratedMessage.\makeMutableCopy(ListT) com.google.protobuf.GeneratedMessage.\makeMutableCopy(ListT,int) [GeneratedMessage.\parseDelimitedWithIOException(Parser\,InputStream)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage__M_parseDelimitedWithIOException_com_google_protobuf_Parser_M__java_io_InputStream_) [GeneratedMessage.\parseDelimitedWithIOException(Parser\,InputStream,ExtensionRegistryLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage__M_parseDelimitedWithIOException_com_google_protobuf_Parser_M__java_io_InputStream_com_google_protobuf_ExtensionRegistryLite_) [GeneratedMessage.\parseWithIOException(Parser\,CodedInputStream)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage__M_parseWithIOException_com_google_protobuf_Parser_M__com_google_protobuf_CodedInputStream_) [GeneratedMessage.\parseWithIOException(Parser\,CodedInputStream,ExtensionRegistryLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage__M_parseWithIOException_com_google_protobuf_Parser_M__com_google_protobuf_CodedInputStream_com_google_protobuf_ExtensionRegistryLite_) [GeneratedMessage.\parseWithIOException(Parser\,InputStream)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage__M_parseWithIOException_com_google_protobuf_Parser_M__java_io_InputStream_) [GeneratedMessage.\parseWithIOException(Parser\,InputStream,ExtensionRegistryLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage__M_parseWithIOException_com_google_protobuf_Parser_M__java_io_InputStream_com_google_protobuf_ExtensionRegistryLite_) com.google.protobuf.GeneratedMessage.\emptyList(java.lang.Class\) com.google.protobuf.GeneratedMessage.\serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField\,com.google.protobuf.MapEntry\,int) com.google.protobuf.GeneratedMessage.\serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField\,com.google.protobuf.MapEntry\,int) com.google.protobuf.GeneratedMessage.\serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField\,com.google.protobuf.MapEntry\,int) com.google.protobuf.GeneratedMessage.\serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField\,com.google.protobuf.MapEntry\,int) com.google.protobuf.GeneratedMessage.canUseUnsafe() [GeneratedMessage.computeStringSize(int,Object)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_computeStringSize_int_java_lang_Object_) [GeneratedMessage.computeStringSizeNoTag(Object)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_computeStringSizeNoTag_java_lang_Object_) com.google.protobuf.GeneratedMessage.emptyBooleanList() com.google.protobuf.GeneratedMessage.emptyDoubleList() com.google.protobuf.GeneratedMessage.emptyFloatList() com.google.protobuf.GeneratedMessage.emptyIntList() com.google.protobuf.GeneratedMessage.emptyLongList() [GeneratedMessage.getAllFields()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getAllFields__) [GeneratedMessage.getDescriptorForType()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getDescriptorForType__) [GeneratedMessage.getField(Descriptors.FieldDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getField_com_google_protobuf_Descriptors_FieldDescriptor_) [GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getOneofFieldDescriptor_com_google_protobuf_Descriptors_OneofDescriptor_) [GeneratedMessage.getParserForType()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getParserForType__) [GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getRepeatedField_com_google_protobuf_Descriptors_FieldDescriptor_int_) [GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getRepeatedFieldCount_com_google_protobuf_Descriptors_FieldDescriptor_) [GeneratedMessage.getSerializedSize()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getSerializedSize__) [GeneratedMessage.getUnknownFields()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getUnknownFields__) [GeneratedMessage.hasField(Descriptors.FieldDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_hasField_com_google_protobuf_Descriptors_FieldDescriptor_) [GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_hasOneof_com_google_protobuf_Descriptors_OneofDescriptor_) [GeneratedMessage.internalGetFieldAccessorTable()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_internalGetFieldAccessorTable__) [GeneratedMessage.internalGetMapField(int)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_internalGetMapField_int_) com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int) [GeneratedMessage.isInitialized()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_isInitialized__) com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object) [GeneratedMessage.makeExtensionsImmutable()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_makeExtensionsImmutable__) com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite) com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter) [GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_parseUnknownField_com_google_protobuf_CodedInputStream_com_google_protobuf_UnknownFieldSet_Builder_com_google_protobuf_ExtensionRegistryLite_int_) com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int) [GeneratedMessage.writeReplace()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_writeReplace__) [GeneratedMessage.writeString(CodedOutputStream,int,Object)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_writeString_com_google_protobuf_CodedOutputStream_int_java_lang_Object_) [GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_writeStringNoTag_com_google_protobuf_CodedOutputStream_java_lang_Object_) [GeneratedMessage.writeTo(CodedOutputStream)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_writeTo_com_google_protobuf_CodedOutputStream_) [Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-) ## Static Fields ### END_TIME_FIELD_NUMBER public static final int END_TIME_FIELD_NUMBER | **Field Value** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | ### KIND_FIELD_NUMBER public static final int KIND_FIELD_NUMBER | **Field Value** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | ### LABELS_FIELD_NUMBER public static final int LABELS_FIELD_NUMBER | **Field Value** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | ### NAME_FIELD_NUMBER public static final int NAME_FIELD_NUMBER | **Field Value** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | ### PARENT_SPAN_ID_FIELD_NUMBER public static final int PARENT_SPAN_ID_FIELD_NUMBER | **Field Value** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | ### SPAN_ID_FIELD_NUMBER public static final int SPAN_ID_FIELD_NUMBER | **Field Value** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | ### START_TIME_FIELD_NUMBER public static final int START_TIME_FIELD_NUMBER | **Field Value** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | ## Static Methods ### getDefaultInstance() public static TraceSpan getDefaultInstance() | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | ### getDescriptor() public static final Descriptors.Descriptor getDescriptor() | **Returns** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Descriptors.Descriptor.html` | | ### newBuilder() public static TraceSpan.Builder newBuilder() | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan.Builder` | | ### newBuilder(TraceSpan prototype) public static TraceSpan.Builder newBuilder(TraceSpan prototype) | **Parameter** || |---|---| | **Name** | **Description** | | `prototype` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan.Builder` | | ### parseDelimitedFrom(InputStream input) public static TraceSpan parseDelimitedFrom(InputStream input) | **Parameter** || |---|---| | **Name** | **Description** | | `input` | `https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` | | ### parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) public static TraceSpan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) | **Parameters** || |---|---| | **Name** | **Description** | | `input` | `https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html` | | `extensionRegistry` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ExtensionRegistryLite.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` | | ### parseFrom(byte\[\] data) public static TraceSpan parseFrom(byte[] data) | **Parameter** || |---|---| | **Name** | **Description** | | `data` | `byte[]` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.InvalidProtocolBufferException.html` | | ### parseFrom(byte\[\] data, ExtensionRegistryLite extensionRegistry) public static TraceSpan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) | **Parameters** || |---|---| | **Name** | **Description** | | `data` | `byte[]` | | `extensionRegistry` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ExtensionRegistryLite.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.InvalidProtocolBufferException.html` | | ### parseFrom(ByteString data) public static TraceSpan parseFrom(ByteString data) | **Parameter** || |---|---| | **Name** | **Description** | | `data` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.InvalidProtocolBufferException.html` | | ### parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) public static TraceSpan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) | **Parameters** || |---|---| | **Name** | **Description** | | `data` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | | `extensionRegistry` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ExtensionRegistryLite.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.InvalidProtocolBufferException.html` | | ### parseFrom(CodedInputStream input) public static TraceSpan parseFrom(CodedInputStream input) | **Parameter** || |---|---| | **Name** | **Description** | | `input` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.CodedInputStream.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` | | ### parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) public static TraceSpan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) | **Parameters** || |---|---| | **Name** | **Description** | | `input` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.CodedInputStream.html` | | `extensionRegistry` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ExtensionRegistryLite.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` | | ### parseFrom(InputStream input) public static TraceSpan parseFrom(InputStream input) | **Parameter** || |---|---| | **Name** | **Description** | | `input` | `https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` | | ### parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) public static TraceSpan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) | **Parameters** || |---|---| | **Name** | **Description** | | `input` | `https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html` | | `extensionRegistry` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ExtensionRegistryLite.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` | | ### parseFrom(ByteBuffer data) public static TraceSpan parseFrom(ByteBuffer data) | **Parameter** || |---|---| | **Name** | **Description** | | `data` | `https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.InvalidProtocolBufferException.html` | | ### parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) public static TraceSpan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) | **Parameters** || |---|---| | **Name** | **Description** | | `data` | `https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html` | | `extensionRegistry` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ExtensionRegistryLite.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | | **Exceptions** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.InvalidProtocolBufferException.html` | | ### parser() public static Parser parser() | **Returns** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Parser.html` | | ## Methods ### containsLabels(String key) public boolean containsLabels(String key) Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: - `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). - `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: - `/agent` - `/component` - `/error/message` - `/error/name` - `/http/client_city` - `/http/client_country` - `/http/client_protocol` - `/http/client_region` - `/http/host` - `/http/method` - `/http/path` - `/http/redirected_url` - `/http/request/size` - `/http/response/size` - `/http/route` - `/http/status_code` - `/http/url` - `/http/user_agent` - `/pid` - `/stacktrace` - `/tid` `map labels = 7;` | **Parameter** || |---|---| | **Name** | **Description** | | `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | ### equals(Object obj) public boolean equals(Object obj) | **Parameter** || |---|---| | **Name** | **Description** | | `obj` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | **Overrides** [AbstractMessage.equals(Object other)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html#com_google_protobuf_AbstractMessage_equals_java_lang_Object_) ### getDefaultInstanceForType() public TraceSpan getDefaultInstanceForType() | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan` | | ### getEndTime() public Timestamp getEndTime() End time of the span in nanoseconds from the UNIX epoch. `.google.protobuf.Timestamp end_time = 5;` | **Returns** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | The endTime. | ### getEndTimeOrBuilder() public TimestampOrBuilder getEndTimeOrBuilder() End time of the span in nanoseconds from the UNIX epoch. `.google.protobuf.Timestamp end_time = 5;` | **Returns** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` | | ### getKind() public TraceSpan.SpanKind getKind() Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. `.google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan.SpanKind` | The kind. | ### getKindValue() public int getKindValue() Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. `.google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for kind. | ### getLabels() (deprecated) public Map getLabels() Use [#getLabelsMap()](https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan#com_google_devtools_cloudtrace_v1_TraceSpan_getLabelsMap__) instead. | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html` | | ### getLabelsCount() public int getLabelsCount() Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: - `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). - `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: - `/agent` - `/component` - `/error/message` - `/error/name` - `/http/client_city` - `/http/client_country` - `/http/client_protocol` - `/http/client_region` - `/http/host` - `/http/method` - `/http/path` - `/http/redirected_url` - `/http/request/size` - `/http/response/size` - `/http/route` - `/http/status_code` - `/http/url` - `/http/user_agent` - `/pid` - `/stacktrace` - `/tid` `map labels = 7;` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | ### getLabelsMap() public Map getLabelsMap() Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: - `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). - `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: - `/agent` - `/component` - `/error/message` - `/error/name` - `/http/client_city` - `/http/client_country` - `/http/client_protocol` - `/http/client_region` - `/http/host` - `/http/method` - `/http/path` - `/http/redirected_url` - `/http/request/size` - `/http/response/size` - `/http/route` - `/http/status_code` - `/http/url` - `/http/user_agent` - `/pid` - `/stacktrace` - `/tid` `map labels = 7;` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html` | | ### getLabelsOrDefault(String key, String defaultValue) public String getLabelsOrDefault(String key, String defaultValue) Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: - `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). - `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: - `/agent` - `/component` - `/error/message` - `/error/name` - `/http/client_city` - `/http/client_country` - `/http/client_protocol` - `/http/client_region` - `/http/host` - `/http/method` - `/http/path` - `/http/redirected_url` - `/http/request/size` - `/http/response/size` - `/http/route` - `/http/status_code` - `/http/url` - `/http/user_agent` - `/pid` - `/stacktrace` - `/tid` `map labels = 7;` | **Parameters** || |---|---| | **Name** | **Description** | | `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | | `defaultValue` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | | ### getLabelsOrThrow(String key) public String getLabelsOrThrow(String key) Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: - `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). - `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: - `/agent` - `/component` - `/error/message` - `/error/name` - `/http/client_city` - `/http/client_country` - `/http/client_protocol` - `/http/client_region` - `/http/host` - `/http/method` - `/http/path` - `/http/redirected_url` - `/http/request/size` - `/http/response/size` - `/http/route` - `/http/status_code` - `/http/url` - `/http/user_agent` - `/pid` - `/stacktrace` - `/tid` `map labels = 7;` | **Parameter** || |---|---| | **Name** | **Description** | | `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | | ### getName() public String getName() Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. `string name = 3;` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The name. | ### getNameBytes() public ByteString getNameBytes() Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. `string name = 3;` | **Returns** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for name. | ### getParentSpanId() public long getParentSpanId() Optional. ID of the parent span, if any. `fixed64 parent_span_id = 6 [(.google.api.field_behavior) = OPTIONAL];` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The parentSpanId. | ### getParserForType() public Parser getParserForType() | **Returns** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Parser.html` | | **Overrides** [GeneratedMessage.getParserForType()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getParserForType__) ### getSerializedSize() public int getSerializedSize() | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | **Overrides** [GeneratedMessage.getSerializedSize()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_getSerializedSize__) ### getSpanId() public long getSpanId() Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`. `fixed64 span_id = 1;` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The spanId. | ### getStartTime() public Timestamp getStartTime() Start time of the span in nanoseconds from the UNIX epoch. `.google.protobuf.Timestamp start_time = 4;` | **Returns** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | The startTime. | ### getStartTimeOrBuilder() public TimestampOrBuilder getStartTimeOrBuilder() Start time of the span in nanoseconds from the UNIX epoch. `.google.protobuf.Timestamp start_time = 4;` | **Returns** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` | | ### hasEndTime() public boolean hasEndTime() End time of the span in nanoseconds from the UNIX epoch. `.google.protobuf.Timestamp end_time = 5;` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the endTime field is set. | ### hasStartTime() public boolean hasStartTime() Start time of the span in nanoseconds from the UNIX epoch. `.google.protobuf.Timestamp start_time = 4;` | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the startTime field is set. | ### hashCode() public int hashCode() | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | **Overrides** [AbstractMessage.hashCode()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html#com_google_protobuf_AbstractMessage_hashCode__) ### internalGetFieldAccessorTable() protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable() | **Returns** || |---|---| | **Type** | **Description** | | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.FieldAccessorTable.html` | | **Overrides** [GeneratedMessage.internalGetFieldAccessorTable()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_internalGetFieldAccessorTable__) ### internalGetMapFieldReflection(int number) protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number) | **Parameter** || |---|---| | **Name** | **Description** | | `number` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | **Returns** || |---|---| | **Type** | **Description** | | `com.google.protobuf.MapFieldReflectionAccessor` | | **Overrides** com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int) ### isInitialized() public final boolean isInitialized() | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | | **Overrides** [GeneratedMessage.isInitialized()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_isInitialized__) ### newBuilderForType() public TraceSpan.Builder newBuilderForType() | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan.Builder` | | ### newBuilderForType(AbstractMessage.BuilderParent parent) protected TraceSpan.Builder newBuilderForType(AbstractMessage.BuilderParent parent) | **Parameter** || |---|---| | **Name** | **Description** | | `parent` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.BuilderParent.html` | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan.Builder` | | **Overrides** [AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.html#com_google_protobuf_AbstractMessage_newBuilderForType_com_google_protobuf_AbstractMessage_BuilderParent_) ### toBuilder() public TraceSpan.Builder toBuilder() | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/java/docs/reference/google-cloud-trace/latest/com.google.devtools.cloudtrace.v1.TraceSpan.Builder` | | ### writeTo(CodedOutputStream output) public void writeTo(CodedOutputStream output) | **Parameter** || |---|---| | **Name** | **Description** | | `output` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.CodedOutputStream.html` | **Overrides** [GeneratedMessage.writeTo(CodedOutputStream output)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.html#com_google_protobuf_GeneratedMessage_writeTo_com_google_protobuf_CodedOutputStream_) | **Exceptions** || |---|---| | **Type** | **Description** | | `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` | |