Struct ComponentResponse 

#[non_exhaustive]
pub struct ComponentResponse {
    pub component_name: Option<String>,
    pub description: Option<String>,
    pub component_type_id: Option<String>,
    pub status: Option<Status>,
    pub defined_in: Option<String>,
    pub properties: Option<HashMap<String, PropertyResponse>>,
    pub property_groups: Option<HashMap<String, ComponentPropertyGroupResponse>>,
    pub sync_source: Option<String>,
    pub are_all_properties_returned: Option<bool>,
    pub composite_components: Option<HashMap<String, ComponentSummary>>,
    pub are_all_composite_components_returned: Option<bool>,
}

An object that returns information about a component type create or update request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

component_name: Option<String>

The name of the component.

description: Option<String>

The description of the component type.

component_type_id: Option<String>

The ID of the component type.

status: Option<Status>

The status of the component type.

defined_in: Option<String>

The name of the property definition set in the request.

properties: Option<HashMap<String, PropertyResponse>>

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.

property_groups: Option<HashMap<String, ComponentPropertyGroupResponse>>

The property groups.

sync_source: Option<String>

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

are_all_properties_returned: Option<bool>

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

composite_components: Option<HashMap<String, ComponentSummary>>

This lists objects that contain information about the compositeComponents.

are_all_composite_components_returned: Option<bool>

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

Implementations

impl ComponentResponse

pub fn component_name(&self) -> Option<&str>

The name of the component.

pub fn description(&self) -> Option<&str>

The description of the component type.

pub fn component_type_id(&self) -> Option<&str>

The ID of the component type.

pub fn status(&self) -> Option<&Status>

The status of the component type.

pub fn defined_in(&self) -> Option<&str>

The name of the property definition set in the request.

pub fn properties(&self) -> Option<&HashMap<String, PropertyResponse>>

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.

pub fn property_groups( &self, ) -> Option<&HashMap<String, ComponentPropertyGroupResponse>>

The property groups.

pub fn sync_source(&self) -> Option<&str>

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

pub fn are_all_properties_returned(&self) -> Option<bool>

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

pub fn composite_components(&self) -> Option<&HashMap<String, ComponentSummary>>

This lists objects that contain information about the compositeComponents.

pub fn are_all_composite_components_returned(&self) -> Option<bool>

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

impl ComponentResponse

pub fn builder() -> ComponentResponseBuilder

Creates a new builder-style object to manufacture ComponentResponse.

Trait Implementations

impl Clone for ComponentResponse

fn clone(&self) -> ComponentResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ComponentResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ComponentResponse

fn eq(&self, other: &ComponentResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ComponentResponse