Class CreateVariableRequest

    • Method Detail

      • name

        public final String name()

        The name of the variable.

        Returns:
        The name of the variable.
      • dataType

        public final DataType dataType()

        The data type of the variable.

        If the service returns an enum value that is not available in the current SDK version, dataType will return DataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

        Returns:
        The data type of the variable.
        See Also:
        DataType
      • dataTypeAsString

        public final String dataTypeAsString()

        The data type of the variable.

        If the service returns an enum value that is not available in the current SDK version, dataType will return DataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

        Returns:
        The data type of the variable.
        See Also:
        DataType
      • dataSourceAsString

        public final String dataSourceAsString()

        The source of the data.

        If the service returns an enum value that is not available in the current SDK version, dataSource will return DataSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataSourceAsString().

        Returns:
        The source of the data.
        See Also:
        DataSource
      • defaultValue

        public final String defaultValue()

        The default value for the variable when no value is received.

        Returns:
        The default value for the variable when no value is received.
      • description

        public final String description()

        The description.

        Returns:
        The description.
      • variableType

        public final String variableType()

        The variable type. For more information see Variable types.

        Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT

        Returns:
        The variable type. For more information see Variable types.

        Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final List<Tag> tags()

        A collection of key and value pairs.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        A collection of key and value pairs.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object