Package com.datadog.api.client.v1.model

Class LogsStringBuilderProcessor

java.lang.Object
com.datadog.api.client.v1.model.LogsStringBuilderProcessor
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") public class LogsStringBuilderProcessor extends Object
Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute.

The template is defined by both raw text and blocks with the syntax %{attribute_path} .

Notes:

  • The processor only accepts attributes with values or an array of values in the blocks.
  • If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection.
  • If the target attribute already exists, it is overwritten by the result of the template.
  • Results of the template cannot exceed 256 characters.

  • Field Details

  • Constructor Details

  • Method Details

    • isEnabled

      public LogsStringBuilderProcessor isEnabled(Boolean isEnabled)

    • getIsEnabled

      @Nullable public Boolean getIsEnabled()
      Whether or not the processor is enabled.
      Returns:
      isEnabled

    • setIsEnabled

      public void setIsEnabled(Boolean isEnabled)

    • isReplaceMissing

      public LogsStringBuilderProcessor isReplaceMissing(Boolean isReplaceMissing)

    • getIsReplaceMissing

      @Nullable public Boolean getIsReplaceMissing()
      If true, it replaces all missing attributes of template by an empty string. If false (default), skips the operation for missing attributes.
      Returns:
      isReplaceMissing

    • setIsReplaceMissing

      public void setIsReplaceMissing(Boolean isReplaceMissing)

    • name

      public LogsStringBuilderProcessor name(String name)

    • getName

      @Nullable public String getName()
      Name of the processor.
      Returns:
      name

    • setName

      public void setName(String name)

    • target

      public LogsStringBuilderProcessor target(String target)

    • getTarget

      public String getTarget()
      The name of the attribute that contains the result of the template.
      Returns:
      target

    • setTarget

      public void setTarget(String target)

    • template

      public LogsStringBuilderProcessor template(String template)

    • getTemplate

      public String getTemplate()
      A formula with one or more attributes and raw text.
      Returns:
      template

    • setTemplate

      public void setTemplate(String template)

    • type

      public LogsStringBuilderProcessor type(LogsStringBuilderProcessorType type)

    • getType

      public LogsStringBuilderProcessorType getType()
      Type of logs string builder processor.
      Returns:
      type

    • setType

      public void setType(LogsStringBuilderProcessorType type)

    • putAdditionalProperty

      public LogsStringBuilderProcessor putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - The arbitrary key to set
      value - The associated value
      Returns:
      LogsStringBuilderProcessor

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      The additional properties

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - The arbitrary key to get
      Returns:
      The specific additional property for the given key

    • equals

      public boolean equals(Object o)
      Return true if this LogsStringBuilderProcessor object is equal to o.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object