io.grpc.binarylog.v1

Class GrpcLogEntry

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.grpc.binarylog.v1.GrpcLogEntry

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, GrpcLogEntryOrBuilder, Serializable

public final class GrpcLogEntry
extends GeneratedMessageV3
implements GrpcLogEntryOrBuilder

 Log entry we store in binary logs
 

Protobuf type grpc.binarylog.v1.GrpcLogEntry

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrpcLogEntry.Builder Log entry we store in binary logs
static class	GrpcLogEntry.EventType Enumerates the type of event Note the terminology is different from the RPC semantics definition, but the same meaning is expressed here.
static class	GrpcLogEntry.Logger Enumerates the entity that generates the log entry
static class	GrpcLogEntry.PayloadCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CALL_ID_FIELD_NUMBER
static int	CLIENT_HEADER_FIELD_NUMBER
static int	LOGGER_FIELD_NUMBER
static int	MESSAGE_FIELD_NUMBER
static int	PAYLOAD_TRUNCATED_FIELD_NUMBER
static int	PEER_FIELD_NUMBER
static int	SEQUENCE_ID_WITHIN_CALL_FIELD_NUMBER
static int	SERVER_HEADER_FIELD_NUMBER
static int	TIMESTAMP_FIELD_NUMBER
static int	TRAILER_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getCallId() Uniquely identifies a call.
ClientHeader	getClientHeader() .grpc.binarylog.v1.ClientHeader client_header = 6;
ClientHeaderOrBuilder	getClientHeaderOrBuilder() .grpc.binarylog.v1.ClientHeader client_header = 6;
static GrpcLogEntry	getDefaultInstance()
GrpcLogEntry	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
GrpcLogEntry.Logger	getLogger() One of the above Logger enum
int	getLoggerValue() One of the above Logger enum
Message	getMessage() Used by EVENT_TYPE_CLIENT_MESSAGE, EVENT_TYPE_SERVER_MESSAGE
MessageOrBuilder	getMessageOrBuilder() Used by EVENT_TYPE_CLIENT_MESSAGE, EVENT_TYPE_SERVER_MESSAGE
Parser<GrpcLogEntry>	getParserForType()
GrpcLogEntry.PayloadCase	getPayloadCase()
boolean	getPayloadTruncated() true if payload does not represent the full message or metadata.
Address	getPeer() Peer address information, will only be recorded on the first incoming event.
AddressOrBuilder	getPeerOrBuilder() Peer address information, will only be recorded on the first incoming event.
long	getSequenceIdWithinCall() The entry sequence id for this call.
int	getSerializedSize()
ServerHeader	getServerHeader() .grpc.binarylog.v1.ServerHeader server_header = 7;
ServerHeaderOrBuilder	getServerHeaderOrBuilder() .grpc.binarylog.v1.ServerHeader server_header = 7;
Timestamp	getTimestamp() The timestamp of the binary log message
TimestampOrBuilder	getTimestampOrBuilder() The timestamp of the binary log message
Trailer	getTrailer() .grpc.binarylog.v1.Trailer trailer = 9;
TrailerOrBuilder	getTrailerOrBuilder() .grpc.binarylog.v1.Trailer trailer = 9;
GrpcLogEntry.EventType	getType() .grpc.binarylog.v1.GrpcLogEntry.EventType type = 4;
int	getTypeValue() .grpc.binarylog.v1.GrpcLogEntry.EventType type = 4;
UnknownFieldSet	getUnknownFields()
boolean	hasClientHeader() .grpc.binarylog.v1.ClientHeader client_header = 6;
int	hashCode()
boolean	hasMessage() Used by EVENT_TYPE_CLIENT_MESSAGE, EVENT_TYPE_SERVER_MESSAGE
boolean	hasPeer() Peer address information, will only be recorded on the first incoming event.
boolean	hasServerHeader() .grpc.binarylog.v1.ServerHeader server_header = 7;
boolean	hasTimestamp() The timestamp of the binary log message
boolean	hasTrailer() .grpc.binarylog.v1.Trailer trailer = 9;
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GrpcLogEntry.Builder	newBuilder()
static GrpcLogEntry.Builder	newBuilder(GrpcLogEntry prototype)
GrpcLogEntry.Builder	newBuilderForType()
protected GrpcLogEntry.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static GrpcLogEntry	parseDelimitedFrom(InputStream input)
static GrpcLogEntry	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static GrpcLogEntry	parseFrom(byte[] data)
static GrpcLogEntry	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static GrpcLogEntry	parseFrom(ByteBuffer data)
static GrpcLogEntry	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static GrpcLogEntry	parseFrom(ByteString data)
static GrpcLogEntry	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static GrpcLogEntry	parseFrom(CodedInputStream input)
static GrpcLogEntry	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static GrpcLogEntry	parseFrom(InputStream input)
static GrpcLogEntry	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<GrpcLogEntry>	parser()
GrpcLogEntry.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TIMESTAMP_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

CALL_ID_FIELD_NUMBER

public static final int CALL_ID_FIELD_NUMBER

See Also:

Constant Field Values

SEQUENCE_ID_WITHIN_CALL_FIELD_NUMBER

public static final int SEQUENCE_ID_WITHIN_CALL_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

LOGGER_FIELD_NUMBER

public static final int LOGGER_FIELD_NUMBER

See Also:

Constant Field Values

CLIENT_HEADER_FIELD_NUMBER

public static final int CLIENT_HEADER_FIELD_NUMBER

See Also:

Constant Field Values

SERVER_HEADER_FIELD_NUMBER

public static final int SERVER_HEADER_FIELD_NUMBER

See Also:

Constant Field Values

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER

See Also:

Constant Field Values

TRAILER_FIELD_NUMBER

public static final int TRAILER_FIELD_NUMBER

See Also:

Constant Field Values

PAYLOAD_TRUNCATED_FIELD_NUMBER

public static final int PAYLOAD_TRUNCATED_FIELD_NUMBER

See Also:

Constant Field Values

PEER_FIELD_NUMBER

public static final int PEER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getPayloadCase

public GrpcLogEntry.PayloadCase getPayloadCase()

Specified by:

getPayloadCase in interface GrpcLogEntryOrBuilder

hasTimestamp

public boolean hasTimestamp()

 The timestamp of the binary log message
 

.google.protobuf.Timestamp timestamp = 1;

Specified by:

hasTimestamp in interface GrpcLogEntryOrBuilder

Returns:

Whether the timestamp field is set.

getTimestamp

public Timestamp getTimestamp()

 The timestamp of the binary log message
 

.google.protobuf.Timestamp timestamp = 1;

Specified by:

getTimestamp in interface GrpcLogEntryOrBuilder

Returns:

The timestamp.

getTimestampOrBuilder

public TimestampOrBuilder getTimestampOrBuilder()

 The timestamp of the binary log message
 

.google.protobuf.Timestamp timestamp = 1;

Specified by:

getTimestampOrBuilder in interface GrpcLogEntryOrBuilder

getCallId

public long getCallId()

 Uniquely identifies a call. The value must not be 0 in order to disambiguate
 from an unset value.
 Each call may have several log entries, they will all have the same call_id.
 Nothing is guaranteed about their value other than they are unique across
 different RPCs in the same gRPC process.
 

uint64 call_id = 2;

Specified by:

getCallId in interface GrpcLogEntryOrBuilder

Returns:

The callId.

getSequenceIdWithinCall

public long getSequenceIdWithinCall()

 The entry sequence id for this call. The first GrpcLogEntry has a
 value of 1, to disambiguate from an unset value. The purpose of
 this field is to detect missing entries in environments where
 durability or ordering is not guaranteed.
 

uint64 sequence_id_within_call = 3;

Specified by:

getSequenceIdWithinCall in interface GrpcLogEntryOrBuilder

Returns:

The sequenceIdWithinCall.

getTypeValue

public int getTypeValue()

.grpc.binarylog.v1.GrpcLogEntry.EventType type = 4;

Specified by:

getTypeValue in interface GrpcLogEntryOrBuilder

Returns:

The enum numeric value on the wire for type.

getType

public GrpcLogEntry.EventType getType()

.grpc.binarylog.v1.GrpcLogEntry.EventType type = 4;

Specified by:

getType in interface GrpcLogEntryOrBuilder

Returns:

The type.

getLoggerValue

public int getLoggerValue()

 One of the above Logger enum
 

.grpc.binarylog.v1.GrpcLogEntry.Logger logger = 5;

Specified by:

getLoggerValue in interface GrpcLogEntryOrBuilder

Returns:

The enum numeric value on the wire for logger.

getLogger

public GrpcLogEntry.Logger getLogger()

 One of the above Logger enum
 

.grpc.binarylog.v1.GrpcLogEntry.Logger logger = 5;

Specified by:

getLogger in interface GrpcLogEntryOrBuilder

Returns:

The logger.

hasClientHeader

public boolean hasClientHeader()

.grpc.binarylog.v1.ClientHeader client_header = 6;

Specified by:

hasClientHeader in interface GrpcLogEntryOrBuilder

Returns:

Whether the clientHeader field is set.

getClientHeader

public ClientHeader getClientHeader()

.grpc.binarylog.v1.ClientHeader client_header = 6;

Specified by:

getClientHeader in interface GrpcLogEntryOrBuilder

Returns:

The clientHeader.

getClientHeaderOrBuilder

public ClientHeaderOrBuilder getClientHeaderOrBuilder()

.grpc.binarylog.v1.ClientHeader client_header = 6;

Specified by:

getClientHeaderOrBuilder in interface GrpcLogEntryOrBuilder

hasServerHeader

public boolean hasServerHeader()

.grpc.binarylog.v1.ServerHeader server_header = 7;

Specified by:

hasServerHeader in interface GrpcLogEntryOrBuilder

Returns:

Whether the serverHeader field is set.

getServerHeader

public ServerHeader getServerHeader()

.grpc.binarylog.v1.ServerHeader server_header = 7;

Specified by:

getServerHeader in interface GrpcLogEntryOrBuilder

Returns:

The serverHeader.

getServerHeaderOrBuilder

public ServerHeaderOrBuilder getServerHeaderOrBuilder()

.grpc.binarylog.v1.ServerHeader server_header = 7;

Specified by:

getServerHeaderOrBuilder in interface GrpcLogEntryOrBuilder

hasMessage

public boolean hasMessage()

 Used by EVENT_TYPE_CLIENT_MESSAGE, EVENT_TYPE_SERVER_MESSAGE
 

.grpc.binarylog.v1.Message message = 8;

Specified by:

hasMessage in interface GrpcLogEntryOrBuilder

Returns:

Whether the message field is set.

getMessage

public Message getMessage()

 Used by EVENT_TYPE_CLIENT_MESSAGE, EVENT_TYPE_SERVER_MESSAGE
 

.grpc.binarylog.v1.Message message = 8;

Specified by:

getMessage in interface GrpcLogEntryOrBuilder

Returns:

The message.

getMessageOrBuilder

public MessageOrBuilder getMessageOrBuilder()

 Used by EVENT_TYPE_CLIENT_MESSAGE, EVENT_TYPE_SERVER_MESSAGE
 

.grpc.binarylog.v1.Message message = 8;

Specified by:

getMessageOrBuilder in interface GrpcLogEntryOrBuilder

hasTrailer

public boolean hasTrailer()

.grpc.binarylog.v1.Trailer trailer = 9;

Specified by:

hasTrailer in interface GrpcLogEntryOrBuilder

Returns:

Whether the trailer field is set.

getTrailer

public Trailer getTrailer()

.grpc.binarylog.v1.Trailer trailer = 9;

Specified by:

getTrailer in interface GrpcLogEntryOrBuilder

Returns:

The trailer.

getTrailerOrBuilder

public TrailerOrBuilder getTrailerOrBuilder()

.grpc.binarylog.v1.Trailer trailer = 9;

Specified by:

getTrailerOrBuilder in interface GrpcLogEntryOrBuilder

getPayloadTruncated

public boolean getPayloadTruncated()

 true if payload does not represent the full message or metadata.
 

bool payload_truncated = 10;

Specified by:

getPayloadTruncated in interface GrpcLogEntryOrBuilder

Returns:

The payloadTruncated.

hasPeer

public boolean hasPeer()

 Peer address information, will only be recorded on the first
 incoming event. On client side, peer is logged on
 EVENT_TYPE_SERVER_HEADER normally or EVENT_TYPE_SERVER_TRAILER in
 the case of trailers-only. On server side, peer is always
 logged on EVENT_TYPE_CLIENT_HEADER.
 

.grpc.binarylog.v1.Address peer = 11;

Specified by:

hasPeer in interface GrpcLogEntryOrBuilder

Returns:

Whether the peer field is set.

getPeer

public Address getPeer()

 Peer address information, will only be recorded on the first
 incoming event. On client side, peer is logged on
 EVENT_TYPE_SERVER_HEADER normally or EVENT_TYPE_SERVER_TRAILER in
 the case of trailers-only. On server side, peer is always
 logged on EVENT_TYPE_CLIENT_HEADER.
 

.grpc.binarylog.v1.Address peer = 11;

Specified by:

getPeer in interface GrpcLogEntryOrBuilder

Returns:

The peer.

getPeerOrBuilder

public AddressOrBuilder getPeerOrBuilder()

 Peer address information, will only be recorded on the first
 incoming event. On client side, peer is logged on
 EVENT_TYPE_SERVER_HEADER normally or EVENT_TYPE_SERVER_TRAILER in
 the case of trailers-only. On server side, peer is always
 logged on EVENT_TYPE_CLIENT_HEADER.
 

.grpc.binarylog.v1.Address peer = 11;

Specified by:

getPeerOrBuilder in interface GrpcLogEntryOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static GrpcLogEntry parseFrom(ByteBuffer data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static GrpcLogEntry parseFrom(ByteBuffer data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static GrpcLogEntry parseFrom(ByteString data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static GrpcLogEntry parseFrom(ByteString data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static GrpcLogEntry parseFrom(byte[] data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static GrpcLogEntry parseFrom(byte[] data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static GrpcLogEntry parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static GrpcLogEntry parseFrom(InputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static GrpcLogEntry parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static GrpcLogEntry parseDelimitedFrom(InputStream input,
                                              ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static GrpcLogEntry parseFrom(CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static GrpcLogEntry parseFrom(CodedInputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public GrpcLogEntry.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static GrpcLogEntry.Builder newBuilder()

newBuilder

public static GrpcLogEntry.Builder newBuilder(GrpcLogEntry prototype)

toBuilder

public GrpcLogEntry.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected GrpcLogEntry.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static GrpcLogEntry getDefaultInstance()

parser

public static Parser<GrpcLogEntry> parser()

getParserForType

public Parser<GrpcLogEntry> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public GrpcLogEntry getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder