Class SemanticType

    • Method Detail

      • typeName

        public final String typeName()

        The semantic type name.

        Returns:
        The semantic type name.
      • subTypeName

        public final String subTypeName()

        The semantic type sub type name.

        Returns:
        The semantic type sub type name.
      • hasTypeParameters

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

        public final Map<String,​String> typeParameters()

        The semantic type parameters.

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

        Returns:
        The semantic type parameters.
      • truthyCellValue

        public final String truthyCellValue()

        The semantic type truthy cell value.

        Returns:
        The semantic type truthy cell value.
      • hasTruthyCellValueSynonyms

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

        public final List<String> truthyCellValueSynonyms()

        The other names or aliases for the true cell value.

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

        Returns:
        The other names or aliases for the true cell value.
      • falseyCellValue

        public final String falseyCellValue()

        The semantic type falsey cell value.

        Returns:
        The semantic type falsey cell value.
      • hasFalseyCellValueSynonyms

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

        public final List<String> falseyCellValueSynonyms()

        The other names or aliases for the false cell value.

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

        Returns:
        The other names or aliases for the false cell value.
      • 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)