Struct PropertyDefinitionResponse 

#[non_exhaustive]
pub struct PropertyDefinitionResponse {
    pub data_type: Option<DataType>,
    pub is_time_series: bool,
    pub is_required_in_entity: bool,
    pub is_external_id: bool,
    pub is_stored_externally: bool,
    pub is_imported: bool,
    pub is_final: bool,
    pub is_inherited: bool,
    pub default_value: Option<DataValue>,
    pub configuration: Option<HashMap<String, String>>,
    pub display_name: Option<String>,
}

An object that contains response data from a property definition 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.

data_type: Option<DataType>

An object that contains information about the data type.

is_time_series: bool

A Boolean value that specifies whether the property consists of time series data.

is_required_in_entity: bool

A Boolean value that specifies whether the property is required in an entity.

is_external_id: bool

A Boolean value that specifies whether the property ID comes from an external data store.

is_stored_externally: bool

A Boolean value that specifies whether the property is stored externally.

is_imported: bool

A Boolean value that specifies whether the property definition is imported from an external data store.

is_final: bool

A Boolean value that specifies whether the property definition can be updated.

is_inherited: bool

A Boolean value that specifies whether the property definition is inherited from a parent entity.

default_value: Option<DataValue>

An object that contains the default value.

configuration: Option<HashMap<String, String>>

A mapping that specifies configuration information about the property.

display_name: Option<String>

A friendly name for the property.

Implementations

impl PropertyDefinitionResponse

pub fn data_type(&self) -> Option<&DataType>

An object that contains information about the data type.

pub fn is_time_series(&self) -> bool

A Boolean value that specifies whether the property consists of time series data.

pub fn is_required_in_entity(&self) -> bool

A Boolean value that specifies whether the property is required in an entity.

pub fn is_external_id(&self) -> bool

A Boolean value that specifies whether the property ID comes from an external data store.

pub fn is_stored_externally(&self) -> bool

A Boolean value that specifies whether the property is stored externally.

pub fn is_imported(&self) -> bool

A Boolean value that specifies whether the property definition is imported from an external data store.

pub fn is_final(&self) -> bool

A Boolean value that specifies whether the property definition can be updated.

pub fn is_inherited(&self) -> bool

A Boolean value that specifies whether the property definition is inherited from a parent entity.

pub fn default_value(&self) -> Option<&DataValue>

An object that contains the default value.

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

A mapping that specifies configuration information about the property.

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

A friendly name for the property.

impl PropertyDefinitionResponse

pub fn builder() -> PropertyDefinitionResponseBuilder

Creates a new builder-style object to manufacture PropertyDefinitionResponse.

Trait Implementations

impl Clone for PropertyDefinitionResponse

fn clone(&self) -> PropertyDefinitionResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropertyDefinitionResponse

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

Formats the value using the given formatter.

impl PartialEq for PropertyDefinitionResponse

fn eq(&self, other: &PropertyDefinitionResponse) -> 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 PropertyDefinitionResponse