Package markets.alpaca.client.openapi.broker.model

Class TravelRuleRequiredField

java.lang.Object
markets.alpaca.client.openapi.broker.model.TravelRuleRequiredField
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class TravelRuleRequiredField extends Object implements Serializable
Request field required to complete a travel rule action.
See Also:

  • Field Details

  • Constructor Details

    • TravelRuleRequiredField

      public TravelRuleRequiredField()

  • Method Details

    • description

      public TravelRuleRequiredField description(@Nonnull String description)

    • getDescription

      @Nonnull public String getDescription()
      Get description
      Returns:
      description

    • setDescription

      public void setDescription(@Nonnull String description)

    • field

      public TravelRuleRequiredField field(@Nonnull String field)

    • getField

      @Nonnull public String getField()
      Get field
      Returns:
      field

    • setField

      public void setField(@Nonnull String field)

    • options

      public TravelRuleRequiredField options(@Nullable List<TravelRuleFieldOption> options)

    • addOptionsItem

      public TravelRuleRequiredField addOptionsItem(TravelRuleFieldOption optionsItem)

    • getOptions

      @Nullable public List<TravelRuleFieldOption> getOptions()
      List of valid choices for 'enum' types. Null for simple strings or booleans.
      Returns:
      options

    • setOptions

      public void setOptions(@Nullable List<TravelRuleFieldOption> options)

    • valueType

      public TravelRuleRequiredField valueType(@Nonnull TravelRuleRequiredField.ValueTypeEnum valueType)

    • getValueType

      @Nonnull public TravelRuleRequiredField.ValueTypeEnum getValueType()
      Get valueType
      Returns:
      valueType

    • setValueType

      public void setValueType(@Nonnull TravelRuleRequiredField.ValueTypeEnum valueType)

    • putAdditionalProperty

      public TravelRuleRequiredField 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 - name of the property
      value - value of the property
      Returns:
      the TravelRuleRequiredField instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

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

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

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

    • fromJson

      public static TravelRuleRequiredField fromJson(String jsonString) throws IOException
      Create an instance of TravelRuleRequiredField given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of TravelRuleRequiredField
      Throws:
      IOException - if the JSON string is invalid with respect to TravelRuleRequiredField

    • toJson

      public String toJson()
      Convert an instance of TravelRuleRequiredField to an JSON string
      Returns:
      JSON string