Package software.amazon.awssdk.services.servicediscovery.model

Interface DiscoverInstancesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DiscoverInstancesRequest.Builder,DiscoverInstancesRequest>, SdkBuilder<DiscoverInstancesRequest.Builder,DiscoverInstancesRequest>, SdkPojo, SdkRequest.Builder, ServiceDiscoveryRequest.Builder
Enclosing class:
DiscoverInstancesRequest
public static interface DiscoverInstancesRequest.Builder extends ServiceDiscoveryRequest.Builder, SdkPojo, CopyableBuilder<DiscoverInstancesRequest.Builder,DiscoverInstancesRequest>

  • Method Details

    • namespaceName

      DiscoverInstancesRequest.Builder namespaceName(String namespaceName)

      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.

      Parameters:
      namespaceName - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceName

      DiscoverInstancesRequest.Builder serviceName(String serviceName)

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

      Parameters:
      serviceName - The name of the service that you specified when you registered the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DiscoverInstancesRequest.Builder maxResults(Integer maxResults)

      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.

      Parameters:
      maxResults - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryParameters

      DiscoverInstancesRequest.Builder queryParameters(Map<String,String> queryParameters)

      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.

      Parameters:
      queryParameters - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • optionalParameters

      DiscoverInstancesRequest.Builder optionalParameters(Map<String,String> optionalParameters)

      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.

      Parameters:
      optionalParameters - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthStatus

      DiscoverInstancesRequest.Builder healthStatus(String healthStatus)

      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.

      Parameters:
      healthStatus - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • healthStatus

      DiscoverInstancesRequest.Builder healthStatus(HealthStatusFilter healthStatus)

      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.

      Parameters:
      healthStatus - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      DiscoverInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DiscoverInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.