Class ComponentUpdateRequest

    • Method Detail

      • description

        public final String description()

        The description of the component type.

        Returns:
        The description of the component type.
      • componentTypeId

        public final String componentTypeId()

        The ID of the component type.

        Returns:
        The ID of the component type.
      • hasPropertyUpdates

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

        public final Map<String,​PropertyRequest> propertyUpdates()

        An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.

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

        Returns:
        An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.
      • hasPropertyGroupUpdates

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

        public final Map<String,​ComponentPropertyGroupRequest> propertyGroupUpdates()

        The property group updates.

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

        Returns:
        The property group updates.
      • 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)