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

Class Command.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>
org.apache.skywalking.apm.network.common.v3.Command.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, CommandOrBuilder
Enclosing class:
Command
public static final class Command.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder> 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

  • Method Details

    • 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.Builder<Command.Builder>

    • clear

      public Command.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public Command.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>

    • setField

      public Command.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>

    • clearField

      public Command.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>

    • clearOneof

      public Command.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>

    • setRepeatedField

      public Command.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>

    • addRepeatedField

      public Command.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>

    • mergeFrom

      public Command.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Command.Builder>

    • mergeFrom

      public Command.Builder mergeFrom(Command other)

    • isInitialized

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

    • mergeFrom

      public Command.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Command.Builder>
      Throws:
      IOException

    • 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.

    • setCommand

      public Command.Builder setCommand(String value)
       Use command name to distinguish different data type.
      string command = 1;
      Parameters:
      value - The command to set.
      Returns:
      This builder for chaining.

    • clearCommand

      public Command.Builder clearCommand()
       Use command name to distinguish different data type.
      string command = 1;
      Returns:
      This builder for chaining.

    • setCommandBytes

      public Command.Builder setCommandBytes(com.google.protobuf.ByteString value)
       Use command name to distinguish different data type.
      string command = 1;
      Parameters:
      value - The bytes for command to set.
      Returns:
      This builder for chaining.

    • 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

    • 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

    • setArgs

      public Command.Builder setArgs(int index, KeyStringValuePair value)
       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;

    • setArgs

      public Command.Builder setArgs(int index, KeyStringValuePair.Builder builderForValue)
       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;

    • addArgs

      public Command.Builder addArgs(KeyStringValuePair value)
       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;

    • addArgs

      public Command.Builder addArgs(int index, KeyStringValuePair value)
       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;

    • addArgs

      public Command.Builder addArgs(KeyStringValuePair.Builder builderForValue)
       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;

    • addArgs

      public Command.Builder addArgs(int index, KeyStringValuePair.Builder builderForValue)
       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;

    • addAllArgs

      public Command.Builder addAllArgs(Iterable<? extends KeyStringValuePair> values)
       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;

    • clearArgs

      public Command.Builder clearArgs()
       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;

    • removeArgs

      public Command.Builder removeArgs(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;

    • getArgsBuilder

      public KeyStringValuePair.Builder getArgsBuilder(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;

    • 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

    • 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

    • addArgsBuilder

      public KeyStringValuePair.Builder addArgsBuilder()
       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;

    • addArgsBuilder

      public KeyStringValuePair.Builder addArgsBuilder(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;

    • getArgsBuilderList

      public List<KeyStringValuePair.Builder> getArgsBuilderList()
       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;

    • setUnknownFields

      public final Command.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>

    • mergeUnknownFields

      public final Command.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Command.Builder>