Struct aws_sdk_pinpoint::types::SegmentGroup

#[non_exhaustive]
pub struct SegmentGroup {
    pub dimensions: Option<Vec<SegmentDimensions>>,
    pub source_segments: Option<Vec<SegmentReference>>,
    pub source_type: Option<SourceType>,
    pub type: Option<Type>,
}

Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

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.

dimensions: Option<Vec<SegmentDimensions>>

An array that defines the dimensions for the segment.

source_segments: Option<Vec<SegmentReference>>

The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

source_type: Option<SourceType>

Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

type: Option<Type>

Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

Implementations

impl SegmentGroup

pub fn dimensions(&self) -> &[SegmentDimensions]

An array that defines the dimensions for the segment.

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

pub fn source_segments(&self) -> &[SegmentReference]

The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

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

pub fn source_type(&self) -> Option<&SourceType>

Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

pub fn type(&self) -> Option<&Type>

Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

impl SegmentGroup

pub fn builder() -> SegmentGroupBuilder

Creates a new builder-style object to manufacture SegmentGroup.

Trait Implementations

impl Clone for SegmentGroup

fn clone(&self) -> SegmentGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SegmentGroup

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

Formats the value using the given formatter.

impl PartialEq for SegmentGroup

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SegmentGroup