Struct Property 

#[non_exhaustive]
pub struct Property {
    pub name: String,
    pub description: String,
    pub required: bool,
    pub default_value: Option<String>,
    pub property_types: Vec<PropertyType>,
    pub allowed_values: Option<Vec<AllowedValue>>,
    pub data_operation_scopes: Option<Vec<DataOperation>>,
    pub key_override: Option<String>,
    pub property_location: Option<PropertyLocation>,
}

An object that defines a connection type for a compute environment.

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.

name: String

The name of the property.

description: String

A description of the property.

required: bool

Indicates whether the property is required.

default_value: Option<String>

The default value for the property.

property_types: Vec<PropertyType>

Describes the type of property.

allowed_values: Option<Vec<AllowedValue>>

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

data_operation_scopes: Option<Vec<DataOperation>>

Indicates which data operations are applicable to the property.

key_override: Option<String>

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

property_location: Option<PropertyLocation>

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

Implementations

impl Property

pub fn name(&self) -> &str

The name of the property.

pub fn description(&self) -> &str

A description of the property.

pub fn required(&self) -> bool

Indicates whether the property is required.

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

The default value for the property.

pub fn property_types(&self) -> &[PropertyType]

Describes the type of property.

pub fn allowed_values(&self) -> &[AllowedValue]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .allowed_values.is_none().

pub fn data_operation_scopes(&self) -> &[DataOperation]

Indicates which data operations are applicable to the property.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .data_operation_scopes.is_none().

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

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

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

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

impl Property

pub fn builder() -> PropertyBuilder

Creates a new builder-style object to manufacture Property.

Trait Implementations

impl Clone for Property

fn clone(&self) -> Property

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Property

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

Formats the value using the given formatter.

impl PartialEq for Property

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