Class SegmentBody


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               date="2026-03-05T10:45:26.516033Z[Etc/UTC]",
               comments="Generator version: 7.18.0")
    public class SegmentBody
    extends java.lang.Object
    SegmentBody
    • Field Detail

      • SERIALIZED_NAME_NAME

        public static final java.lang.String SERIALIZED_NAME_NAME
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_KEY

        public static final java.lang.String SERIALIZED_NAME_KEY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_DESCRIPTION

        public static final java.lang.String SERIALIZED_NAME_DESCRIPTION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_TAGS

        public static final java.lang.String SERIALIZED_NAME_TAGS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_UNBOUNDED

        public static final java.lang.String SERIALIZED_NAME_UNBOUNDED
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_UNBOUNDED_CONTEXT_KIND

        public static final java.lang.String SERIALIZED_NAME_UNBOUNDED_CONTEXT_KIND
        See Also:
        Constant Field Values
      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields
      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields
    • Constructor Detail

      • SegmentBody

        public SegmentBody()
    • Method Detail

      • name

        public SegmentBody name​(@Nonnull
                                java.lang.String name)
      • getName

        @Nonnull
        public java.lang.String getName()
        A human-friendly name for the segment
        Returns:
        name
      • setName

        public void setName​(@Nonnull
                            java.lang.String name)
      • key

        public SegmentBody key​(@Nonnull
                               java.lang.String key)
      • getKey

        @Nonnull
        public java.lang.String getKey()
        A unique key used to reference the segment
        Returns:
        key
      • setKey

        public void setKey​(@Nonnull
                           java.lang.String key)
      • description

        public SegmentBody description​(@Nullable
                                       java.lang.String description)
      • getDescription

        @Nullable
        public java.lang.String getDescription()
        A description of the segment's purpose
        Returns:
        description
      • setDescription

        public void setDescription​(@Nullable
                                   java.lang.String description)
      • tags

        public SegmentBody tags​(@Nullable
                                java.util.List<java.lang.String> tags)
      • addTagsItem

        public SegmentBody addTagsItem​(java.lang.String tagsItem)
      • getTags

        @Nullable
        public java.util.List<java.lang.String> getTags()
        Tags for the segment
        Returns:
        tags
      • setTags

        public void setTags​(@Nullable
                            java.util.List<java.lang.String> tags)
      • unbounded

        public SegmentBody unbounded​(@Nullable
                                     java.lang.Boolean unbounded)
      • getUnbounded

        @Nullable
        public java.lang.Boolean getUnbounded()
        Whether to create a standard segment (<code>false</code>) or a big segment (<code>true</code>). Standard segments include rule-based and smaller list-based segments. Big segments include larger list-based segments and synced segments. Only use a big segment if you need to add more than 15,000 individual targets.
        Returns:
        unbounded
      • setUnbounded

        public void setUnbounded​(@Nullable
                                 java.lang.Boolean unbounded)
      • unboundedContextKind

        public SegmentBody unboundedContextKind​(@Nullable
                                                java.lang.String unboundedContextKind)
      • getUnboundedContextKind

        @Nullable
        public java.lang.String getUnboundedContextKind()
        For big segments, the targeted context kind.
        Returns:
        unboundedContextKind
      • setUnboundedContextKind

        public void setUnboundedContextKind​(@Nullable
                                            java.lang.String unboundedContextKind)
      • putAdditionalProperty

        public SegmentBody putAdditionalProperty​(java.lang.String key,
                                                 java.lang.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 - name of the property
        value - value of the property
        Returns:
        the SegmentBody instance itself
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.
        Returns:
        a map of objects
      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.
        Parameters:
        key - name of the property
        Returns:
        an object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                        throws java.io.IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        java.io.IOException - if the JSON Element is invalid with respect to SegmentBody
      • fromJson

        public static SegmentBody fromJson​(java.lang.String jsonString)
                                    throws java.io.IOException
        Create an instance of SegmentBody given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of SegmentBody
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to SegmentBody
      • toJson

        public java.lang.String toJson()
        Convert an instance of SegmentBody to an JSON string
        Returns:
        JSON string