Class ComponentResponse

    • Method Detail

      • componentName

        public final String componentName()

        The name of the component.

        Returns:
        The name of the component.
      • 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.
      • status

        public final Status status()

        The status of the component type.

        Returns:
        The status of the component type.
      • definedIn

        public final String definedIn()

        The name of the property definition set in the request.

        Returns:
        The name of the property definition set in the request.
      • hasProperties

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

        public final Map<String,​PropertyResponse> properties()

        An object that maps strings to the properties to set in the component type. 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 hasProperties() method.

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

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

        public final Map<String,​ComponentPropertyGroupResponse> propertyGroups()

        The property groups.

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

        Returns:
        The property groups.
      • syncSource

        public final String syncSource()

        The syncSource of the sync job, if this entity was created by a sync job.

        Returns:
        The syncSource of the sync job, if this entity was created by a sync job.
      • areAllPropertiesReturned

        public final Boolean areAllPropertiesReturned()

        This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.

        Returns:
        This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
      • hasCompositeComponents

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

        public final Map<String,​ComponentSummary> compositeComponents()

        This lists objects that contain information about the compositeComponents.

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

        Returns:
        This lists objects that contain information about the compositeComponents.
      • areAllCompositeComponentsReturned

        public final Boolean areAllCompositeComponentsReturned()

        This flag notes whether all compositeComponents are returned in the API response.

        Returns:
        This flag notes whether all compositeComponents are returned in the API response.
      • 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)