Struct aws_sdk_cloudsearch::input::DescribeIndexFieldsInput

#[non_exhaustive]
pub struct DescribeIndexFieldsInput {
    pub domain_name: Option<String>,
    pub field_names: Option<Vec<String>>,
    pub deployed: Option<bool>,
}

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

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.

domain_name: Option<String>

The name of the domain you want to describe.

field_names: Option<Vec<String>>

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

deployed: Option<bool>

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Implementations

impl DescribeIndexFieldsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DescribeIndexFields, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DescribeIndexFields>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeIndexFieldsInput

impl DescribeIndexFieldsInput

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

The name of the domain you want to describe.

pub fn field_names(&self) -> Option<&[String]>

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

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

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Trait Implementations

impl Clone for DescribeIndexFieldsInput

fn clone(&self) -> DescribeIndexFieldsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeIndexFieldsInput

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

Formats the value using the given formatter.

impl PartialEq<DescribeIndexFieldsInput> for DescribeIndexFieldsInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for DescribeIndexFieldsInput