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

Class AdminConfigurationsEvent

java.lang.Object
markets.alpaca.client.openapi.broker.model.AdminConfigurationsEvent
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AdminConfigurationsEvent extends Object implements Serializable
Represents a change to admin configurations, as broadcast over the **events** streaming API. Only fields whose value changed are included; unrelated update events will not include a flag that did not change. Depending on the type of the Admin Configuration, the sent event will behave differently. For bool flags we are only sending the new value. For example, the following payload means that the disable_shorting flag was set to true: ``` { \"disable_shorting\": true } ``` For other data types, we are embedding the old and new values into the payload. For example changing the max_margin_multiplier from 4 to 1 will yield this payload: ``` { \"max_margin_multiplier\": { \"from\": 4, \"to\": 1 } } ``` Introducing an override value from the default will yield a null value as `from`. For example restricting the max_margin_multiplier to 1 from default will yield the following payload: ``` { \"max_margin_multiplier\": { \"from\": null, \"to\": 1 } } ```
See Also:

  • Field Details

    • SERIALIZED_NAME_ACCT_DAILY_TRANSFER_LIMIT

      public static final String SERIALIZED_NAME_ACCT_DAILY_TRANSFER_LIMIT
      See Also:

    • SERIALIZED_NAME_ALLOW_INSTANT_ACH

      public static final String SERIALIZED_NAME_ALLOW_INSTANT_ACH
      See Also:

    • SERIALIZED_NAME_DISABLE_ALGODASH_ACCESS

      public static final String SERIALIZED_NAME_DISABLE_ALGODASH_ACCESS
      See Also:

    • SERIALIZED_NAME_DISABLE_API_KEY

      public static final String SERIALIZED_NAME_DISABLE_API_KEY
      See Also:

    • SERIALIZED_NAME_DISABLE_CRYPTO

      public static final String SERIALIZED_NAME_DISABLE_CRYPTO
      See Also:

    • SERIALIZED_NAME_DISABLE_DAY_TRADING

      public static final String SERIALIZED_NAME_DISABLE_DAY_TRADING
      See Also:

    • SERIALIZED_NAME_DISABLE_FRACTIONAL

      public static final String SERIALIZED_NAME_DISABLE_FRACTIONAL
      See Also:

    • SERIALIZED_NAME_DISABLE_SHORTING

      public static final String SERIALIZED_NAME_DISABLE_SHORTING
      See Also:

    • SERIALIZED_NAME_INCOMING_TRANSFERS_BLOCKED

      public static final String SERIALIZED_NAME_INCOMING_TRANSFERS_BLOCKED
      See Also:

    • SERIALIZED_NAME_MAX_MARGIN_MULTIPLIER

      public static final String SERIALIZED_NAME_MAX_MARGIN_MULTIPLIER
      See Also:

    • SERIALIZED_NAME_MAX_OPTIONS_TRADING_LEVEL

      public static final String SERIALIZED_NAME_MAX_OPTIONS_TRADING_LEVEL
      See Also:

    • SERIALIZED_NAME_OUTGOING_TRANSFERS_BLOCKED

      public static final String SERIALIZED_NAME_OUTGOING_TRANSFERS_BLOCKED
      See Also:

    • SERIALIZED_NAME_RESTRICT_TO_LIQUIDATION_REASONS

      public static final String SERIALIZED_NAME_RESTRICT_TO_LIQUIDATION_REASONS
      See Also:

    • openapiFields

      public static HashSet<String> openapiFields

    • openapiRequiredFields

      public static HashSet<String> openapiRequiredFields

  • Constructor Details

    • AdminConfigurationsEvent

      public AdminConfigurationsEvent()

  • Method Details

    • acctDailyTransferLimit

      public AdminConfigurationsEvent acctDailyTransferLimit(@Nullable AdminConfigurationsEventAcctDailyTransferLimit acctDailyTransferLimit)

    • getAcctDailyTransferLimit

      @Nullable public AdminConfigurationsEventAcctDailyTransferLimit getAcctDailyTransferLimit()
      Get acctDailyTransferLimit
      Returns:
      acctDailyTransferLimit

    • setAcctDailyTransferLimit

      public void setAcctDailyTransferLimit(@Nullable AdminConfigurationsEventAcctDailyTransferLimit acctDailyTransferLimit)

    • allowInstantAch

      public AdminConfigurationsEvent allowInstantAch(@Nullable Boolean allowInstantAch)

    • getAllowInstantAch

      @Nullable public Boolean getAllowInstantAch()
      If true, the account is allowed to perform instant ACH
      Returns:
      allowInstantAch

    • setAllowInstantAch

      public void setAllowInstantAch(@Nullable Boolean allowInstantAch)

    • disableAlgodashAccess

      public AdminConfigurationsEvent disableAlgodashAccess(@Nullable Boolean disableAlgodashAccess)

    • getDisableAlgodashAccess

      @Nullable public Boolean getDisableAlgodashAccess()
      If true, the account is allowed to access algo dash
      Returns:
      disableAlgodashAccess

    • setDisableAlgodashAccess

      public void setDisableAlgodashAccess(@Nullable Boolean disableAlgodashAccess)

    • disableApiKey

      public AdminConfigurationsEvent disableApiKey(@Nullable Boolean disableApiKey)

    • getDisableApiKey

      @Nullable public Boolean getDisableApiKey()
      If true, the account's API key will be disabled
      Returns:
      disableApiKey

    • setDisableApiKey

      public void setDisableApiKey(@Nullable Boolean disableApiKey)

    • disableCrypto

      public AdminConfigurationsEvent disableCrypto(@Nullable Boolean disableCrypto)

    • getDisableCrypto

      @Nullable public Boolean getDisableCrypto()
      If true, the account is not allowed to trade cryptos
      Returns:
      disableCrypto

    • setDisableCrypto

      public void setDisableCrypto(@Nullable Boolean disableCrypto)

    • disableDayTrading

      public AdminConfigurationsEvent disableDayTrading(@Nullable Boolean disableDayTrading)

    • getDisableDayTrading

      @Nullable public Boolean getDisableDayTrading()
      If true, the account is not allowed to day trade (e.g. buy and sell the same security on the same day)
      Returns:
      disableDayTrading

    • setDisableDayTrading

      public void setDisableDayTrading(@Nullable Boolean disableDayTrading)

    • disableFractional

      public AdminConfigurationsEvent disableFractional(@Nullable Boolean disableFractional)

    • getDisableFractional

      @Nullable public Boolean getDisableFractional()
      If true, the account cannot create orders for fractional share positions
      Returns:
      disableFractional

    • setDisableFractional

      public void setDisableFractional(@Nullable Boolean disableFractional)

    • disableShorting

      public AdminConfigurationsEvent disableShorting(@Nullable Boolean disableShorting)

    • getDisableShorting

      @Nullable public Boolean getDisableShorting()
      If true the account is not allowed to create short position orders
      Returns:
      disableShorting

    • setDisableShorting

      public void setDisableShorting(@Nullable Boolean disableShorting)

    • incomingTransfersBlocked

      public AdminConfigurationsEvent incomingTransfersBlocked(@Nullable Boolean incomingTransfersBlocked)

    • getIncomingTransfersBlocked

      @Nullable public Boolean getIncomingTransfersBlocked()
      If true, incoming transfers to this account are rejected
      Returns:
      incomingTransfersBlocked

    • setIncomingTransfersBlocked

      public void setIncomingTransfersBlocked(@Nullable Boolean incomingTransfersBlocked)

    • maxMarginMultiplier

      public AdminConfigurationsEvent maxMarginMultiplier(@Nullable AdminConfigurationsEventAcctDailyTransferLimit maxMarginMultiplier)

    • getMaxMarginMultiplier

      @Nullable public AdminConfigurationsEventAcctDailyTransferLimit getMaxMarginMultiplier()
      Get maxMarginMultiplier
      Returns:
      maxMarginMultiplier

    • setMaxMarginMultiplier

      public void setMaxMarginMultiplier(@Nullable AdminConfigurationsEventAcctDailyTransferLimit maxMarginMultiplier)

    • maxOptionsTradingLevel

      public AdminConfigurationsEvent maxOptionsTradingLevel(@Nullable AdminConfigurationsEventAcctDailyTransferLimit maxOptionsTradingLevel)

    • getMaxOptionsTradingLevel

      @Nullable public AdminConfigurationsEventAcctDailyTransferLimit getMaxOptionsTradingLevel()
      Get maxOptionsTradingLevel
      Returns:
      maxOptionsTradingLevel

    • setMaxOptionsTradingLevel

      public void setMaxOptionsTradingLevel(@Nullable AdminConfigurationsEventAcctDailyTransferLimit maxOptionsTradingLevel)

    • outgoingTransfersBlocked

      public AdminConfigurationsEvent outgoingTransfersBlocked(@Nullable Boolean outgoingTransfersBlocked)

    • getOutgoingTransfersBlocked

      @Nullable public Boolean getOutgoingTransfersBlocked()
      If true, outgoing transfers from this account are rejected
      Returns:
      outgoingTransfersBlocked

    • setOutgoingTransfersBlocked

      public void setOutgoingTransfersBlocked(@Nullable Boolean outgoingTransfersBlocked)

    • restrictToLiquidationReasons

      public AdminConfigurationsEvent restrictToLiquidationReasons(@Nullable RestrictToLiquidationReasons restrictToLiquidationReasons)

    • getRestrictToLiquidationReasons

      @Nullable public RestrictToLiquidationReasons getRestrictToLiquidationReasons()
      Get restrictToLiquidationReasons
      Returns:
      restrictToLiquidationReasons

    • setRestrictToLiquidationReasons

      public void setRestrictToLiquidationReasons(@Nullable RestrictToLiquidationReasons restrictToLiquidationReasons)

    • putAdditionalProperty

      public AdminConfigurationsEvent 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 AdminConfigurationsEvent 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 AdminConfigurationsEvent

    • fromJson

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

    • toJson

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