Struct PropertyBuilder 

#[non_exhaustive]
pub struct PropertyBuilder { /* private fields */ }

A builder for Property.

Implementations

impl PropertyBuilder

pub fn name(self, input: impl Into<String>) -> Self

The name of the property.

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

The name of the property.

pub fn get_name(&self) -> &Option<String>

The name of the property.

pub fn description(self, input: impl Into<String>) -> Self

A description of the property.

This field is required.

pub fn set_description(self, input: Option<String>) -> Self

A description of the property.

pub fn get_description(&self) -> &Option<String>

A description of the property.

pub fn required(self, input: bool) -> Self

Indicates whether the property is required.

This field is required.

pub fn set_required(self, input: Option<bool>) -> Self

Indicates whether the property is required.

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

Indicates whether the property is required.

pub fn default_value(self, input: impl Into<String>) -> Self

The default value for the property.

pub fn set_default_value(self, input: Option<String>) -> Self

The default value for the property.

pub fn get_default_value(&self) -> &Option<String>

The default value for the property.

pub fn property_types(self, input: PropertyType) -> Self

Appends an item to property_types.

To override the contents of this collection use set_property_types.

Describes the type of property.

pub fn set_property_types(self, input: Option<Vec<PropertyType>>) -> Self

Describes the type of property.

pub fn get_property_types(&self) -> &Option<Vec<PropertyType>>

Describes the type of property.

pub fn allowed_values(self, input: AllowedValue) -> Self

Appends an item to allowed_values.

To override the contents of this collection use set_allowed_values.

A list of AllowedValue objects representing the values allowed for the property.

pub fn set_allowed_values(self, input: Option<Vec<AllowedValue>>) -> Self

A list of AllowedValue objects representing the values allowed for the property.

pub fn get_allowed_values(&self) -> &Option<Vec<AllowedValue>>

A list of AllowedValue objects representing the values allowed for the property.

pub fn data_operation_scopes(self, input: DataOperation) -> Self

Appends an item to data_operation_scopes.

To override the contents of this collection use set_data_operation_scopes.

Indicates which data operations are applicable to the property.

pub fn set_data_operation_scopes( self, input: Option<Vec<DataOperation>>, ) -> Self

Indicates which data operations are applicable to the property.

pub fn get_data_operation_scopes(&self) -> &Option<Vec<DataOperation>>

Indicates which data operations are applicable to the property.

pub fn key_override(self, input: impl Into<String>) -> Self

A key name to use when sending this property in API requests, if different from the display name.

pub fn set_key_override(self, input: Option<String>) -> Self

A key name to use when sending this property in API requests, if different from the display name.

pub fn get_key_override(&self) -> &Option<String>

A key name to use when sending this property in API requests, if different from the display name.

pub fn property_location(self, input: PropertyLocation) -> Self

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

pub fn set_property_location(self, input: Option<PropertyLocation>) -> Self

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

pub fn get_property_location(&self) -> &Option<PropertyLocation>

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

pub fn build(self) -> Result<Property, BuildError>

Consumes the builder and constructs a Property. This method will fail if any of the following fields are not set:

• name
• description
• required

Trait Implementations

impl Clone for PropertyBuilder

fn clone(&self) -> PropertyBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropertyBuilder

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

Formats the value using the given formatter.

impl Default for PropertyBuilder

fn default() -> PropertyBuilder

Returns the “default value” for a type.

impl PartialEq for PropertyBuilder

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