Struct aws_sdk_servicediscovery::operation::discover_instances::builders::DiscoverInstancesFluentBuilder

pub struct DiscoverInstancesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to DiscoverInstances.

Discovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace. DiscoverInstances returns a randomized list of instances allowing customers to distribute traffic evenly across instances. For public and private DNS namespaces, you can also use DNS queries to discover instances.

Implementations

impl DiscoverInstancesFluentBuilder

pub fn as_input(&self) -> &DiscoverInstancesInputBuilder

Access the DiscoverInstances as a reference.

pub async fn send( self ) -> Result<DiscoverInstancesOutput, SdkError<DiscoverInstancesError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<DiscoverInstancesOutput, DiscoverInstancesError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace. In most cases, Name and HttpName match. However, if you reuse Name for namespace creation, a generated hash is added to HttpName to distinguish the two.

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

The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace. In most cases, Name and HttpName match. However, if you reuse Name for namespace creation, a generated hash is added to HttpName to distinguish the two.

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

The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace. In most cases, Name and HttpName match. However, if you reuse Name for namespace creation, a generated hash is added to HttpName to distinguish the two.

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

The name of the service that you specified when you registered the instance.

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

The name of the service that you specified when you registered the instance.

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

The name of the service that you specified when you registered the instance.

pub fn max_results(self, input: i32) -> Self

The maximum number of instances that you want Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of instances that you want Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

pub fn get_max_results(&self) -> &Option<i32>

The maximum number of instances that you want Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

pub fn query_parameters( self, k: impl Into<String>, v: impl Into<String> ) -> Self

Adds a key-value pair to QueryParameters.

To override the contents of this collection use set_query_parameters.

Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.

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

Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.

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

Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.

pub fn optional_parameters( self, k: impl Into<String>, v: impl Into<String> ) -> Self

Adds a key-value pair to OptionalParameters.

To override the contents of this collection use set_optional_parameters.

Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.

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

Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.

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

Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.

pub fn health_status(self, input: HealthStatusFilter) -> Self

The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

HEALTHY

Returns healthy instances.

UNHEALTHY

Returns unhealthy instances.

ALL

Returns all instances.

HEALTHY_OR_ELSE_ALL

Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

pub fn set_health_status(self, input: Option<HealthStatusFilter>) -> Self

The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

HEALTHY

Returns healthy instances.

UNHEALTHY

Returns unhealthy instances.

ALL

Returns all instances.

HEALTHY_OR_ELSE_ALL

Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

pub fn get_health_status(&self) -> &Option<HealthStatusFilter>

The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

HEALTHY

Returns healthy instances.

UNHEALTHY

Returns unhealthy instances.

ALL

Returns all instances.

HEALTHY_OR_ELSE_ALL

Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

Trait Implementations

impl Clone for DiscoverInstancesFluentBuilder

fn clone(&self) -> DiscoverInstancesFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DiscoverInstancesFluentBuilder

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

Formats the value using the given formatter.