Package org.apache.skywalking.apm.network.common.v3

Class Command

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.apache.skywalking.apm.network.common.v3.Command
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, CommandOrBuilder
public final class Command extends com.google.protobuf.GeneratedMessageV3 implements CommandOrBuilder
 Command represents an protocol customized data when return.
 When the agent communicates with the OAP side using gRPC, the OAP uses Command to return the data content to the Agent.
 The available commands are,
 Name: ConfigurationDiscoveryCommand
 Args:
     SerialNumber: String
     UUID: String
     properties: Key-value pairs rely on agent-side implementations
 Ref, Java agent supported configurations, https://skywalking.apache.org/docs/skywalking-java/next/en/setup/service-agent/java-agent/configuration-discovery/
 Name: ProfileTaskQuery
 Args:
     SerialNumber: String
     TaskId: String
     EndpointName: String
     Duration: Integer
     MinDurationThreshold: Integer
     DumpPeriod: Integer
     MaxSamplingCount: Integer
     StartTime: Date Timestamp
     CreateTime: Date Timestamp
 Name: EBPFProfilingTaskQuery
 Args:
     TaskId: String
     ProcessId: Integer List
     TaskUpdateTime: Date timestamp
     TriggerType: Enum, value = FIXED_TIME
     TargetType: Enum, value = ON_CPU, OFF_CPU or NETWORK
     TaskStartTime: Date Timestamp
     ExtensionConfigJSON: JSON serialization of NetworkSamplings.
         --- NetworkSamplings ---
         NetworkSamplings: List
             URIRegex: String
             MinDuration: Integer
             When4xx: Boolean
             When5xx: Boolean
             Settings: Object
                 RequireCompleteRequest: Boolean
                 MaxRequestSize: Integer
                 RequireCompleteResponse: Boolean
                 MaxResponseSize: Integer
         ------------------------
     FixedTriggerDuration: Long
 Name: ContinuousProfilingPolicyQuery
 Args:
     ServiceWithPolicyJSON: List JSON serialization of ServiceWithPolicy.
         --- ServiceWithPolicy ---
         ServiceName: String
         UUID: String
         Profiling: Multiple profiling configuration. Map
             Key: Profiling type. Enum, value = ON_CPU, OFF_CPU, NETWORK
             Value: Profiling policies. Map
                 Key: Monitoring type. Enum, value = PROCESS_CPU, PROCESS_THREAD_COUNT, SYSTEM_LOAD, HTTP_ERROR_RATE, HTTP_AVG_RESPONSE_TIME
                 Value: Policy configuration. Object.
                     Threshold: String
                     Period(s): Integer
                     Count: Integer
                     URIList: List<String>
                     URIRegex: String
         ---------------------------
 Name: ContinuousProfilingReportTask
 Args:
     TaskId: String
Protobuf type skywalking.v3.Command
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Command.Builder
    Command represents an protocol customized data when return.

    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 Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ARGS_FIELD_NUMBER
     
    static final int
    COMMAND_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
    Description
    boolean
    equals(Object obj)
     
    KeyStringValuePair
    getArgs(int index)
    Data content in command.
    int
    getArgsCount()
    Data content in command.
    List<KeyStringValuePair>
    getArgsList()
    Data content in command.
    KeyStringValuePairOrBuilder
    getArgsOrBuilder(int index)
    Data content in command.
    List<? extends KeyStringValuePairOrBuilder>
    getArgsOrBuilderList()
    Data content in command.
    String
    getCommand()
    Use command name to distinguish different data type.
    com.google.protobuf.ByteString
    getCommandBytes()
    Use command name to distinguish different data type.
    static Command
    getDefaultInstance()
     
    Command
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Command>
    getParserForType()
     
    int
    getSerializedSize()
     
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Command.Builder
    newBuilder()
     
    static Command.Builder
    newBuilder(Command prototype)
     
    Command.Builder
    newBuilderForType()
     
    protected Command.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Command
    parseDelimitedFrom(InputStream input)
     
    static Command
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Command
    parseFrom(byte[] data)
     
    static Command
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Command
    parseFrom(com.google.protobuf.ByteString data)
     
    static Command
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Command
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Command
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Command
    parseFrom(InputStream input)
     
    static Command
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Command
    parseFrom(ByteBuffer data)
     
    static Command
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Command>
    parser()
     
    Command.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • 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

    • getCommand

      public String getCommand()
       Use command name to distinguish different data type.
      string command = 1;
      Specified by:
      getCommand in interface CommandOrBuilder
      Returns:
      The command.

    • getCommandBytes

      public com.google.protobuf.ByteString getCommandBytes()
       Use command name to distinguish different data type.
      string command = 1;
      Specified by:
      getCommandBytes in interface CommandOrBuilder
      Returns:
      The bytes for command.

    • getArgsList

      public List<KeyStringValuePair> getArgsList()
       Data content in command.
 The value of content needs to be serialized as string for transmission.
 Basic data type: convert as string.
 The list of basic data: multiple data are split by ",".
 Complex data: serialize string through json.
      repeated .skywalking.v3.KeyStringValuePair args = 2;
      Specified by:
      getArgsList in interface CommandOrBuilder

    • getArgsOrBuilderList

      public List<? extends KeyStringValuePairOrBuilder> getArgsOrBuilderList()
       Data content in command.
 The value of content needs to be serialized as string for transmission.
 Basic data type: convert as string.
 The list of basic data: multiple data are split by ",".
 Complex data: serialize string through json.
      repeated .skywalking.v3.KeyStringValuePair args = 2;
      Specified by:
      getArgsOrBuilderList in interface CommandOrBuilder

    • getArgsCount

      public int getArgsCount()
       Data content in command.
 The value of content needs to be serialized as string for transmission.
 Basic data type: convert as string.
 The list of basic data: multiple data are split by ",".
 Complex data: serialize string through json.
      repeated .skywalking.v3.KeyStringValuePair args = 2;
      Specified by:
      getArgsCount in interface CommandOrBuilder

    • getArgs

      public KeyStringValuePair getArgs(int index)
       Data content in command.
 The value of content needs to be serialized as string for transmission.
 Basic data type: convert as string.
 The list of basic data: multiple data are split by ",".
 Complex data: serialize string through json.
      repeated .skywalking.v3.KeyStringValuePair args = 2;
      Specified by:
      getArgs in interface CommandOrBuilder

    • getArgsOrBuilder

      public KeyStringValuePairOrBuilder getArgsOrBuilder(int index)
       Data content in command.
 The value of content needs to be serialized as string for transmission.
 Basic data type: convert as string.
 The list of basic data: multiple data are split by ",".
 Complex data: serialize string through json.
      repeated .skywalking.v3.KeyStringValuePair args = 2;
      Specified by:
      getArgsOrBuilder in interface CommandOrBuilder

    • 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 Command parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Command parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Command parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Command parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Command parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Command parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Command parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Command.Builder newBuilder()

    • newBuilder

      public static Command.Builder newBuilder(Command prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Command getDefaultInstance()

    • parser

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

    • getParserForType

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