Package io.grpc.channelz.v1

Class Channel

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ChannelOrBuilder, java.io.Serializable
    public final class Channel
extends com.google.protobuf.GeneratedMessageV3
implements ChannelOrBuilder
     Channel is a logical grouping of channels, subchannels, and sockets.
    Protobuf type grpc.channelz.v1.Channel
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Channel.Builder
      Channel is a logical grouping of channels, subchannels, and sockets.

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      ChannelRef getChannelRef​(int index)
      There are no ordering guarantees on the order of channel refs.
      int getChannelRefCount()
      There are no ordering guarantees on the order of channel refs.
      java.util.List<ChannelRef> getChannelRefList()
      There are no ordering guarantees on the order of channel refs.
      ChannelRefOrBuilder getChannelRefOrBuilder​(int index)
      There are no ordering guarantees on the order of channel refs.
      java.util.List<? extends ChannelRefOrBuilder> getChannelRefOrBuilderList()
      There are no ordering guarantees on the order of channel refs.
      ChannelData getData()
      Data specific to this channel.
      ChannelDataOrBuilder getDataOrBuilder()
      Data specific to this channel.
      static Channel getDefaultInstance()  
      Channel getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<Channel> getParserForType()  
      ChannelRef getRef()
      The identifier for this channel.
      ChannelRefOrBuilder getRefOrBuilder()
      The identifier for this channel.
      int getSerializedSize()  
      SocketRef getSocketRef​(int index)
      There are no ordering guarantees on the order of sockets.
      int getSocketRefCount()
      There are no ordering guarantees on the order of sockets.
      java.util.List<SocketRef> getSocketRefList()
      There are no ordering guarantees on the order of sockets.
      SocketRefOrBuilder getSocketRefOrBuilder​(int index)
      There are no ordering guarantees on the order of sockets.
      java.util.List<? extends SocketRefOrBuilder> getSocketRefOrBuilderList()
      There are no ordering guarantees on the order of sockets.
      SubchannelRef getSubchannelRef​(int index)
      At most one of 'channel_ref+subchannel_ref' and 'socket' is set.
      int getSubchannelRefCount()
      At most one of 'channel_ref+subchannel_ref' and 'socket' is set.
      java.util.List<SubchannelRef> getSubchannelRefList()
      At most one of 'channel_ref+subchannel_ref' and 'socket' is set.
      SubchannelRefOrBuilder getSubchannelRefOrBuilder​(int index)
      At most one of 'channel_ref+subchannel_ref' and 'socket' is set.
      java.util.List<? extends SubchannelRefOrBuilder> getSubchannelRefOrBuilderList()
      At most one of 'channel_ref+subchannel_ref' and 'socket' is set.
      boolean hasData()
      Data specific to this channel.
      int hashCode()  
      boolean hasRef()
      The identifier for this channel.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Channel.Builder newBuilder()  
      static Channel.Builder newBuilder​(Channel prototype)  
      Channel.Builder newBuilderForType()  
      protected Channel.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Channel parseDelimitedFrom​(java.io.InputStream input)  
      static Channel parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Channel parseFrom​(byte[] data)  
      static Channel parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Channel parseFrom​(com.google.protobuf.ByteString data)  
      static Channel parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Channel parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Channel parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Channel parseFrom​(java.io.InputStream input)  
      static Channel parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Channel parseFrom​(java.nio.ByteBuffer data)  
      static Channel parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Channel> parser()  
      Channel.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasRef

        public boolean hasRef()
         The identifier for this channel. This should be set.
        .grpc.channelz.v1.ChannelRef ref = 1;
        Specified by:
        hasRef in interface ChannelOrBuilder
        Returns:
        Whether the ref field is set.

      • getRef

        public ChannelRef getRef()
         The identifier for this channel. This should be set.
        .grpc.channelz.v1.ChannelRef ref = 1;
        Specified by:
        getRef in interface ChannelOrBuilder
        Returns:
        The ref.

      • hasData

        public boolean hasData()
         Data specific to this channel.
        .grpc.channelz.v1.ChannelData data = 2;
        Specified by:
        hasData in interface ChannelOrBuilder
        Returns:
        Whether the data field is set.

      • getData

        public ChannelData getData()
         Data specific to this channel.
        .grpc.channelz.v1.ChannelData data = 2;
        Specified by:
        getData in interface ChannelOrBuilder
        Returns:
        The data.

      • getChannelRefList

        public java.util.List<ChannelRef> getChannelRefList()
         There are no ordering guarantees on the order of channel refs.
 There may not be cycles in the ref graph.
 A channel ref may be present in more than one channel or subchannel.
        repeated .grpc.channelz.v1.ChannelRef channel_ref = 3;
        Specified by:
        getChannelRefList in interface ChannelOrBuilder

      • getChannelRefOrBuilderList

        public java.util.List<? extends ChannelRefOrBuilder> getChannelRefOrBuilderList()
         There are no ordering guarantees on the order of channel refs.
 There may not be cycles in the ref graph.
 A channel ref may be present in more than one channel or subchannel.
        repeated .grpc.channelz.v1.ChannelRef channel_ref = 3;
        Specified by:
        getChannelRefOrBuilderList in interface ChannelOrBuilder

      • getChannelRefCount

        public int getChannelRefCount()
         There are no ordering guarantees on the order of channel refs.
 There may not be cycles in the ref graph.
 A channel ref may be present in more than one channel or subchannel.
        repeated .grpc.channelz.v1.ChannelRef channel_ref = 3;
        Specified by:
        getChannelRefCount in interface ChannelOrBuilder

      • getChannelRef

        public ChannelRef getChannelRef​(int index)
         There are no ordering guarantees on the order of channel refs.
 There may not be cycles in the ref graph.
 A channel ref may be present in more than one channel or subchannel.
        repeated .grpc.channelz.v1.ChannelRef channel_ref = 3;
        Specified by:
        getChannelRef in interface ChannelOrBuilder

      • getChannelRefOrBuilder

        public ChannelRefOrBuilder getChannelRefOrBuilder​(int index)
         There are no ordering guarantees on the order of channel refs.
 There may not be cycles in the ref graph.
 A channel ref may be present in more than one channel or subchannel.
        repeated .grpc.channelz.v1.ChannelRef channel_ref = 3;
        Specified by:
        getChannelRefOrBuilder in interface ChannelOrBuilder

      • getSubchannelRefList

        public java.util.List<SubchannelRef> getSubchannelRefList()
         At most one of 'channel_ref+subchannel_ref' and 'socket' is set.
 There are no ordering guarantees on the order of subchannel refs.
 There may not be cycles in the ref graph.
 A sub channel ref may be present in more than one channel or subchannel.
        repeated .grpc.channelz.v1.SubchannelRef subchannel_ref = 4;
        Specified by:
        getSubchannelRefList in interface ChannelOrBuilder

      • getSubchannelRefOrBuilderList

        public java.util.List<? extends SubchannelRefOrBuilder> getSubchannelRefOrBuilderList()
         At most one of 'channel_ref+subchannel_ref' and 'socket' is set.
 There are no ordering guarantees on the order of subchannel refs.
 There may not be cycles in the ref graph.
 A sub channel ref may be present in more than one channel or subchannel.
        repeated .grpc.channelz.v1.SubchannelRef subchannel_ref = 4;
        Specified by:
        getSubchannelRefOrBuilderList in interface ChannelOrBuilder

      • getSubchannelRefCount

        public int getSubchannelRefCount()
         At most one of 'channel_ref+subchannel_ref' and 'socket' is set.
 There are no ordering guarantees on the order of subchannel refs.
 There may not be cycles in the ref graph.
 A sub channel ref may be present in more than one channel or subchannel.
        repeated .grpc.channelz.v1.SubchannelRef subchannel_ref = 4;
        Specified by:
        getSubchannelRefCount in interface ChannelOrBuilder

      • getSubchannelRef

        public SubchannelRef getSubchannelRef​(int index)
         At most one of 'channel_ref+subchannel_ref' and 'socket' is set.
 There are no ordering guarantees on the order of subchannel refs.
 There may not be cycles in the ref graph.
 A sub channel ref may be present in more than one channel or subchannel.
        repeated .grpc.channelz.v1.SubchannelRef subchannel_ref = 4;
        Specified by:
        getSubchannelRef in interface ChannelOrBuilder

      • getSubchannelRefOrBuilder

        public SubchannelRefOrBuilder getSubchannelRefOrBuilder​(int index)
         At most one of 'channel_ref+subchannel_ref' and 'socket' is set.
 There are no ordering guarantees on the order of subchannel refs.
 There may not be cycles in the ref graph.
 A sub channel ref may be present in more than one channel or subchannel.
        repeated .grpc.channelz.v1.SubchannelRef subchannel_ref = 4;
        Specified by:
        getSubchannelRefOrBuilder in interface ChannelOrBuilder

      • getSocketRefList

        public java.util.List<SocketRef> getSocketRefList()
         There are no ordering guarantees on the order of sockets.
        repeated .grpc.channelz.v1.SocketRef socket_ref = 5;
        Specified by:
        getSocketRefList in interface ChannelOrBuilder

      • getSocketRefCount

        public int getSocketRefCount()
         There are no ordering guarantees on the order of sockets.
        repeated .grpc.channelz.v1.SocketRef socket_ref = 5;
        Specified by:
        getSocketRefCount in interface ChannelOrBuilder

      • getSocketRef

        public SocketRef getSocketRef​(int index)
         There are no ordering guarantees on the order of sockets.
        repeated .grpc.channelz.v1.SocketRef socket_ref = 5;
        Specified by:
        getSocketRef in interface ChannelOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Channel parseFrom​(java.nio.ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Channel parseFrom​(java.nio.ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Channel parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Channel parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Channel parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Channel parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Channel parseFrom​(java.io.InputStream input)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Channel parseFrom​(java.io.InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Channel parseDelimitedFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Channel parseDelimitedFrom​(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Channel parseFrom​(com.google.protobuf.CodedInputStream input)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Channel parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public Channel.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Channel.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Channel.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Channel getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Channel> parser()

      • getParserForType

        public com.google.protobuf.Parser<Channel> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Channel getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder