Class ClientConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClientConfigOrBuilder, Serializable

    public final class ClientConfig
    extends com.google.protobuf.GeneratedMessageV3
    implements ClientConfigOrBuilder
     Client config for SkyWalking tracer.
     
    Protobuf type envoy.config.trace.v3.ClientConfig
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ClientConfig.BackendTokenSpecifierCase  
      static class  ClientConfig.Builder
      Client config for SkyWalking tracer.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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
    • Field Detail

      • SERVICE_NAME_FIELD_NUMBER

        public static final int SERVICE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • INSTANCE_NAME_FIELD_NUMBER

        public static final int INSTANCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • BACKEND_TOKEN_FIELD_NUMBER

        public static final int BACKEND_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values
      • MAX_CACHE_SIZE_FIELD_NUMBER

        public static final int MAX_CACHE_SIZE_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

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

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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
      • getServiceName

        public String getServiceName()
         Service name for SkyWalking tracer. If this field is empty, then local service cluster name
         that configured by :ref:`Bootstrap node <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.node>`
         message's :ref:`cluster <envoy_v3_api_field_config.core.v3.Node.cluster>` field or command line
         option :option:`--service-cluster` will be used. If both this field and local service cluster
         name are empty, ``EnvoyProxy`` is used as the service name by default.
         
        string service_name = 1;
        Specified by:
        getServiceName in interface ClientConfigOrBuilder
        Returns:
        The serviceName.
      • getServiceNameBytes

        public com.google.protobuf.ByteString getServiceNameBytes()
         Service name for SkyWalking tracer. If this field is empty, then local service cluster name
         that configured by :ref:`Bootstrap node <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.node>`
         message's :ref:`cluster <envoy_v3_api_field_config.core.v3.Node.cluster>` field or command line
         option :option:`--service-cluster` will be used. If both this field and local service cluster
         name are empty, ``EnvoyProxy`` is used as the service name by default.
         
        string service_name = 1;
        Specified by:
        getServiceNameBytes in interface ClientConfigOrBuilder
        Returns:
        The bytes for serviceName.
      • getInstanceName

        public String getInstanceName()
         Service instance name for SkyWalking tracer. If this field is empty, then local service node
         that configured by :ref:`Bootstrap node <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.node>`
         message's :ref:`id <envoy_v3_api_field_config.core.v3.Node.id>` field or command line  option
         :option:`--service-node` will be used. If both this field and local service node are empty,
         ``EnvoyProxy`` is used as the instance name by default.
         
        string instance_name = 2;
        Specified by:
        getInstanceName in interface ClientConfigOrBuilder
        Returns:
        The instanceName.
      • getInstanceNameBytes

        public com.google.protobuf.ByteString getInstanceNameBytes()
         Service instance name for SkyWalking tracer. If this field is empty, then local service node
         that configured by :ref:`Bootstrap node <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.node>`
         message's :ref:`id <envoy_v3_api_field_config.core.v3.Node.id>` field or command line  option
         :option:`--service-node` will be used. If both this field and local service node are empty,
         ``EnvoyProxy`` is used as the instance name by default.
         
        string instance_name = 2;
        Specified by:
        getInstanceNameBytes in interface ClientConfigOrBuilder
        Returns:
        The bytes for instanceName.
      • hasBackendToken

        public boolean hasBackendToken()
         Inline authentication token string.
         
        string backend_token = 3 [(.udpa.annotations.sensitive) = true];
        Specified by:
        hasBackendToken in interface ClientConfigOrBuilder
        Returns:
        Whether the backendToken field is set.
      • getBackendToken

        public String getBackendToken()
         Inline authentication token string.
         
        string backend_token = 3 [(.udpa.annotations.sensitive) = true];
        Specified by:
        getBackendToken in interface ClientConfigOrBuilder
        Returns:
        The backendToken.
      • getBackendTokenBytes

        public com.google.protobuf.ByteString getBackendTokenBytes()
         Inline authentication token string.
         
        string backend_token = 3 [(.udpa.annotations.sensitive) = true];
        Specified by:
        getBackendTokenBytes in interface ClientConfigOrBuilder
        Returns:
        The bytes for backendToken.
      • hasMaxCacheSize

        public boolean hasMaxCacheSize()
         Envoy caches the segment in memory when the SkyWalking backend service is temporarily unavailable.
         This field specifies the maximum number of segments that can be cached. If not specified, the
         default is 1024.
         
        .google.protobuf.UInt32Value max_cache_size = 4;
        Specified by:
        hasMaxCacheSize in interface ClientConfigOrBuilder
        Returns:
        Whether the maxCacheSize field is set.
      • getMaxCacheSize

        public com.google.protobuf.UInt32Value getMaxCacheSize()
         Envoy caches the segment in memory when the SkyWalking backend service is temporarily unavailable.
         This field specifies the maximum number of segments that can be cached. If not specified, the
         default is 1024.
         
        .google.protobuf.UInt32Value max_cache_size = 4;
        Specified by:
        getMaxCacheSize in interface ClientConfigOrBuilder
        Returns:
        The maxCacheSize.
      • getMaxCacheSizeOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getMaxCacheSizeOrBuilder()
         Envoy caches the segment in memory when the SkyWalking backend service is temporarily unavailable.
         This field specifies the maximum number of segments that can be cached. If not specified, the
         default is 1024.
         
        .google.protobuf.UInt32Value max_cache_size = 4;
        Specified by:
        getMaxCacheSizeOrBuilder in interface ClientConfigOrBuilder
      • 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 IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        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​(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 ClientConfig parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ClientConfig parseFrom​(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

        public static ClientConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

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

        public static ClientConfig getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<ClientConfig> parser()
      • getParserForType

        public com.google.protobuf.Parser<ClientConfig> 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 ClientConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder