Class Property

    • Method Detail

      • name

        public final String name()

        The name of the property.

        Returns:
        The name of the property.
      • description

        public final String description()

        A description of the property.

        Returns:
        A description of the property.
      • required

        public final Boolean required()

        Indicates whether the property is required.

        Returns:
        Indicates whether the property is required.
      • defaultValue

        public final String defaultValue()

        The default value for the property.

        Returns:
        The default value for the property.
      • propertyTypes

        public final List<PropertyType> propertyTypes()

        Describes the type of property.

        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 hasPropertyTypes() method.

        Returns:
        Describes the type of property.
      • hasPropertyTypes

        public final boolean hasPropertyTypes()
        For responses, this returns true if the service returned a value for the PropertyTypes 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.
      • propertyTypesAsStrings

        public final List<String> propertyTypesAsStrings()

        Describes the type of property.

        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 hasPropertyTypes() method.

        Returns:
        Describes the type of property.
      • hasAllowedValues

        public final boolean hasAllowedValues()
        For responses, this returns true if the service returned a value for the AllowedValues 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.
      • allowedValues

        public final List<AllowedValue> allowedValues()

        A list of AllowedValue objects representing the values allowed for the property.

        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 hasAllowedValues() method.

        Returns:
        A list of AllowedValue objects representing the values allowed for the property.
      • dataOperationScopes

        public final List<DataOperation> dataOperationScopes()

        Indicates which data operations are applicable to the property.

        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 hasDataOperationScopes() method.

        Returns:
        Indicates which data operations are applicable to the property.
      • hasDataOperationScopes

        public final boolean hasDataOperationScopes()
        For responses, this returns true if the service returned a value for the DataOperationScopes 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.
      • dataOperationScopesAsStrings

        public final List<String> dataOperationScopesAsStrings()

        Indicates which data operations are applicable to the property.

        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 hasDataOperationScopes() method.

        Returns:
        Indicates which data operations are applicable to the property.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)