Package software.amazon.awssdk.services.servicediscovery

Interface ServiceDiscoveryAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ServiceDiscoveryAsyncClient extends AwsClient
Service client for accessing ServiceDiscovery asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. Cloud Map

With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance becomes available, you can call the Cloud Map API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.

  • Field Details

  • Method Details

    • createHttpNamespace

      default CompletableFuture<CreateHttpNamespaceResponse> createHttpNamespace(CreateHttpNamespaceRequest createHttpNamespaceRequest)

      Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

      For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.

      Parameters:
      createHttpNamespaceRequest -
      Returns:
      A Java Future containing the result of the CreateHttpNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceAlreadyExistsException The namespace that you're trying to create already exists.
      • ResourceLimitExceededException The resource can't be created because you've reached the quota on the number of resources.
      • DuplicateRequestException The operation is already in progress.
      • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHttpNamespace

      default CompletableFuture<CreateHttpNamespaceResponse> createHttpNamespace(Consumer<CreateHttpNamespaceRequest.Builder> createHttpNamespaceRequest)

      Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

      For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.


      This is a convenience which creates an instance of the CreateHttpNamespaceRequest.Builder avoiding the need to create one manually via CreateHttpNamespaceRequest.builder()

      Parameters:
      createHttpNamespaceRequest - A Consumer that will call methods on CreateHttpNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateHttpNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceAlreadyExistsException The namespace that you're trying to create already exists.
      • ResourceLimitExceededException The resource can't be created because you've reached the quota on the number of resources.
      • DuplicateRequestException The operation is already in progress.
      • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPrivateDnsNamespace

      default CompletableFuture<CreatePrivateDnsNamespaceResponse> createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest createPrivateDnsNamespaceRequest)

      Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service is backend.example.com. Service instances that are registered using a private DNS namespace can be discovered using either a DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.

      Parameters:
      createPrivateDnsNamespaceRequest -
      Returns:
      A Java Future containing the result of the CreatePrivateDnsNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceAlreadyExistsException The namespace that you're trying to create already exists.
      • ResourceLimitExceededException The resource can't be created because you've reached the quota on the number of resources.
      • DuplicateRequestException The operation is already in progress.
      • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPrivateDnsNamespace

      default CompletableFuture<CreatePrivateDnsNamespaceResponse> createPrivateDnsNamespace(Consumer<CreatePrivateDnsNamespaceRequest.Builder> createPrivateDnsNamespaceRequest)

      Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service is backend.example.com. Service instances that are registered using a private DNS namespace can be discovered using either a DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.


      This is a convenience which creates an instance of the CreatePrivateDnsNamespaceRequest.Builder avoiding the need to create one manually via CreatePrivateDnsNamespaceRequest.builder()

      Parameters:
      createPrivateDnsNamespaceRequest - A Consumer that will call methods on CreatePrivateDnsNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePrivateDnsNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceAlreadyExistsException The namespace that you're trying to create already exists.
      • ResourceLimitExceededException The resource can't be created because you've reached the quota on the number of resources.
      • DuplicateRequestException The operation is already in progress.
      • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPublicDnsNamespace

      default CompletableFuture<CreatePublicDnsNamespaceResponse> createPublicDnsNamespace(CreatePublicDnsNamespaceRequest createPublicDnsNamespaceRequest)

      Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service is backend.example.com. You can discover instances that were registered with a public DNS namespace by using either a DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.

      The CreatePublicDnsNamespace API operation is not supported in the Amazon Web Services GovCloud (US) Regions.

      Parameters:
      createPublicDnsNamespaceRequest -
      Returns:
      A Java Future containing the result of the CreatePublicDnsNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceAlreadyExistsException The namespace that you're trying to create already exists.
      • ResourceLimitExceededException The resource can't be created because you've reached the quota on the number of resources.
      • DuplicateRequestException The operation is already in progress.
      • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPublicDnsNamespace

      default CompletableFuture<CreatePublicDnsNamespaceResponse> createPublicDnsNamespace(Consumer<CreatePublicDnsNamespaceRequest.Builder> createPublicDnsNamespaceRequest)

      Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service is backend.example.com. You can discover instances that were registered with a public DNS namespace by using either a DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.

      The CreatePublicDnsNamespace API operation is not supported in the Amazon Web Services GovCloud (US) Regions.


      This is a convenience which creates an instance of the CreatePublicDnsNamespaceRequest.Builder avoiding the need to create one manually via CreatePublicDnsNamespaceRequest.builder()

      Parameters:
      createPublicDnsNamespaceRequest - A Consumer that will call methods on CreatePublicDnsNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePublicDnsNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceAlreadyExistsException The namespace that you're trying to create already exists.
      • ResourceLimitExceededException The resource can't be created because you've reached the quota on the number of resources.
      • DuplicateRequestException The operation is already in progress.
      • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createService

      default CompletableFuture<CreateServiceResponse> createService(CreateServiceRequest createServiceRequest)

      Creates a service. This action defines the configuration for the following entities:

      • For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:

        • A

        • AAAA

        • A and AAAA

        • SRV

        • CNAME

      • Optionally, a health check

      After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the values in the configuration to create the specified entities.

      For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.

      Parameters:
      createServiceRequest -
      Returns:
      A Java Future containing the result of the CreateService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ResourceLimitExceededException The resource can't be created because you've reached the quota on the number of resources.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • ServiceAlreadyExistsException The service can't be created because a service with the same name already exists.
      • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createService

      default CompletableFuture<CreateServiceResponse> createService(Consumer<CreateServiceRequest.Builder> createServiceRequest)

      Creates a service. This action defines the configuration for the following entities:

      • For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:

        • A

        • AAAA

        • A and AAAA

        • SRV

        • CNAME

      • Optionally, a health check

      After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the values in the configuration to create the specified entities.

      For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.


      This is a convenience which creates an instance of the CreateServiceRequest.Builder avoiding the need to create one manually via CreateServiceRequest.builder()

      Parameters:
      createServiceRequest - A Consumer that will call methods on CreateServiceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ResourceLimitExceededException The resource can't be created because you've reached the quota on the number of resources.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • ServiceAlreadyExistsException The service can't be created because a service with the same name already exists.
      • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNamespace

      default CompletableFuture<DeleteNamespaceResponse> deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)

      Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.

      Parameters:
      deleteNamespaceRequest -
      Returns:
      A Java Future containing the result of the DeleteNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • DuplicateRequestException The operation is already in progress.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNamespace

      default CompletableFuture<DeleteNamespaceResponse> deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest)

      Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.


      This is a convenience which creates an instance of the DeleteNamespaceRequest.Builder avoiding the need to create one manually via DeleteNamespaceRequest.builder()

      Parameters:
      deleteNamespaceRequest - A Consumer that will call methods on DeleteNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • DuplicateRequestException The operation is already in progress.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteService

      default CompletableFuture<DeleteServiceResponse> deleteService(DeleteServiceRequest deleteServiceRequest)

      Deletes a specified service. If the service still contains one or more registered instances, the request fails.

      Parameters:
      deleteServiceRequest -
      Returns:
      A Java Future containing the result of the DeleteService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteService

      default CompletableFuture<DeleteServiceResponse> deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest)

      Deletes a specified service. If the service still contains one or more registered instances, the request fails.


      This is a convenience which creates an instance of the DeleteServiceRequest.Builder avoiding the need to create one manually via DeleteServiceRequest.builder()

      Parameters:
      deleteServiceRequest - A Consumer that will call methods on DeleteServiceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterInstance

      default CompletableFuture<DeregisterInstanceResponse> deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)

      Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.

      Parameters:
      deregisterInstanceRequest -
      Returns:
      A Java Future containing the result of the DeregisterInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DuplicateRequestException The operation is already in progress.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterInstance

      default CompletableFuture<DeregisterInstanceResponse> deregisterInstance(Consumer<DeregisterInstanceRequest.Builder> deregisterInstanceRequest)

      Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.


      This is a convenience which creates an instance of the DeregisterInstanceRequest.Builder avoiding the need to create one manually via DeregisterInstanceRequest.builder()

      Parameters:
      deregisterInstanceRequest - A Consumer that will call methods on DeregisterInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DuplicateRequestException The operation is already in progress.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • discoverInstances

      default CompletableFuture<DiscoverInstancesResponse> discoverInstances(DiscoverInstancesRequest discoverInstancesRequest)

      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.

      Parameters:
      discoverInstancesRequest -
      Returns:
      A Java Future containing the result of the DiscoverInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceNotFoundException No service exists with the specified ID.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • RequestLimitExceededException The operation can't be completed because you've reached the quota for the number of requests. For more information, see Cloud Map API request throttling quota in the Cloud Map Developer Guide.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • discoverInstances

      default CompletableFuture<DiscoverInstancesResponse> discoverInstances(Consumer<DiscoverInstancesRequest.Builder> discoverInstancesRequest)

      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.


      This is a convenience which creates an instance of the DiscoverInstancesRequest.Builder avoiding the need to create one manually via DiscoverInstancesRequest.builder()

      Parameters:
      discoverInstancesRequest - A Consumer that will call methods on DiscoverInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DiscoverInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceNotFoundException No service exists with the specified ID.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • RequestLimitExceededException The operation can't be completed because you've reached the quota for the number of requests. For more information, see Cloud Map API request throttling quota in the Cloud Map Developer Guide.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • discoverInstancesRevision

      default CompletableFuture<DiscoverInstancesRevisionResponse> discoverInstancesRevision(DiscoverInstancesRevisionRequest discoverInstancesRevisionRequest)

      Discovers the increasing revision associated with an instance.

      Parameters:
      discoverInstancesRevisionRequest -
      Returns:
      A Java Future containing the result of the DiscoverInstancesRevision operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceNotFoundException No service exists with the specified ID.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • RequestLimitExceededException The operation can't be completed because you've reached the quota for the number of requests. For more information, see Cloud Map API request throttling quota in the Cloud Map Developer Guide.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • discoverInstancesRevision

      default CompletableFuture<DiscoverInstancesRevisionResponse> discoverInstancesRevision(Consumer<DiscoverInstancesRevisionRequest.Builder> discoverInstancesRevisionRequest)

      Discovers the increasing revision associated with an instance.


      This is a convenience which creates an instance of the DiscoverInstancesRevisionRequest.Builder avoiding the need to create one manually via DiscoverInstancesRevisionRequest.builder()

      Parameters:
      discoverInstancesRevisionRequest - A Consumer that will call methods on DiscoverInstancesRevisionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DiscoverInstancesRevision operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceNotFoundException No service exists with the specified ID.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • RequestLimitExceededException The operation can't be completed because you've reached the quota for the number of requests. For more information, see Cloud Map API request throttling quota in the Cloud Map Developer Guide.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstance

      default CompletableFuture<GetInstanceResponse> getInstance(GetInstanceRequest getInstanceRequest)

      Gets information about a specified instance.

      Parameters:
      getInstanceRequest -
      Returns:
      A Java Future containing the result of the GetInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstance

      default CompletableFuture<GetInstanceResponse> getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest)

      Gets information about a specified instance.


      This is a convenience which creates an instance of the GetInstanceRequest.Builder avoiding the need to create one manually via GetInstanceRequest.builder()

      Parameters:
      getInstanceRequest - A Consumer that will call methods on GetInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstancesHealthStatus

      default CompletableFuture<GetInstancesHealthStatusResponse> getInstancesHealthStatus(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest)

      Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

      There's a brief delay between when you register an instance and when the health status for the instance is available.

      Parameters:
      getInstancesHealthStatusRequest -
      Returns:
      A Java Future containing the result of the GetInstancesHealthStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstancesHealthStatus

      default CompletableFuture<GetInstancesHealthStatusResponse> getInstancesHealthStatus(Consumer<GetInstancesHealthStatusRequest.Builder> getInstancesHealthStatusRequest)

      Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

      There's a brief delay between when you register an instance and when the health status for the instance is available.


      This is a convenience which creates an instance of the GetInstancesHealthStatusRequest.Builder avoiding the need to create one manually via GetInstancesHealthStatusRequest.builder()

      Parameters:
      getInstancesHealthStatusRequest - A Consumer that will call methods on GetInstancesHealthStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInstancesHealthStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstancesHealthStatusPaginator

      default GetInstancesHealthStatusPublisher getInstancesHealthStatusPaginator(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest)

      This is a variant of getInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusPublisher publisher = client.getInstancesHealthStatusPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusPublisher publisher = client.getInstancesHealthStatusPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest) operation.

      Parameters:
      getInstancesHealthStatusRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstancesHealthStatusPaginator

      default GetInstancesHealthStatusPublisher getInstancesHealthStatusPaginator(Consumer<GetInstancesHealthStatusRequest.Builder> getInstancesHealthStatusRequest)

      This is a variant of getInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusPublisher publisher = client.getInstancesHealthStatusPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusPublisher publisher = client.getInstancesHealthStatusPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest) operation.


      This is a convenience which creates an instance of the GetInstancesHealthStatusRequest.Builder avoiding the need to create one manually via GetInstancesHealthStatusRequest.builder()

      Parameters:
      getInstancesHealthStatusRequest - A Consumer that will call methods on GetInstancesHealthStatusRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNamespace

      default CompletableFuture<GetNamespaceResponse> getNamespace(GetNamespaceRequest getNamespaceRequest)

      Gets information about a namespace.

      Parameters:
      getNamespaceRequest -
      Returns:
      A Java Future containing the result of the GetNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNamespace

      default CompletableFuture<GetNamespaceResponse> getNamespace(Consumer<GetNamespaceRequest.Builder> getNamespaceRequest)

      Gets information about a namespace.


      This is a convenience which creates an instance of the GetNamespaceRequest.Builder avoiding the need to create one manually via GetNamespaceRequest.builder()

      Parameters:
      getNamespaceRequest - A Consumer that will call methods on GetNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperation

      default CompletableFuture<GetOperationResponse> getOperation(GetOperationRequest getOperationRequest)

      Gets information about any operation that returns an operation ID in the response, such as a CreateHttpNamespace request.

      To get a list of operations that match specified criteria, see ListOperations.

      Parameters:
      getOperationRequest -
      Returns:
      A Java Future containing the result of the GetOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • OperationNotFoundException No operation exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperation

      default CompletableFuture<GetOperationResponse> getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest)

      Gets information about any operation that returns an operation ID in the response, such as a CreateHttpNamespace request.

      To get a list of operations that match specified criteria, see ListOperations.


      This is a convenience which creates an instance of the GetOperationRequest.Builder avoiding the need to create one manually via GetOperationRequest.builder()

      Parameters:
      getOperationRequest - A Consumer that will call methods on GetOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • OperationNotFoundException No operation exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getService

      default CompletableFuture<GetServiceResponse> getService(GetServiceRequest getServiceRequest)

      Gets the settings for a specified service.

      Parameters:
      getServiceRequest -
      Returns:
      A Java Future containing the result of the GetService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getService

      default CompletableFuture<GetServiceResponse> getService(Consumer<GetServiceRequest.Builder> getServiceRequest)

      Gets the settings for a specified service.


      This is a convenience which creates an instance of the GetServiceRequest.Builder avoiding the need to create one manually via GetServiceRequest.builder()

      Parameters:
      getServiceRequest - A Consumer that will call methods on GetServiceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstances

      default CompletableFuture<ListInstancesResponse> listInstances(ListInstancesRequest listInstancesRequest)

      Lists summary information about the instances that you registered by using a specified service.

      Parameters:
      listInstancesRequest -
      Returns:
      A Java Future containing the result of the ListInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceNotFoundException No service exists with the specified ID.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstances

      default CompletableFuture<ListInstancesResponse> listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest)

      Lists summary information about the instances that you registered by using a specified service.


      This is a convenience which creates an instance of the ListInstancesRequest.Builder avoiding the need to create one manually via ListInstancesRequest.builder()

      Parameters:
      listInstancesRequest - A Consumer that will call methods on ListInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceNotFoundException No service exists with the specified ID.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstancesPaginator

      default ListInstancesPublisher listInstancesPaginator(ListInstancesRequest listInstancesRequest)

      This is a variant of listInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest) operation.

      Parameters:
      listInstancesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceNotFoundException No service exists with the specified ID.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstancesPaginator

      default ListInstancesPublisher listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest)

      This is a variant of listInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest) operation.


      This is a convenience which creates an instance of the ListInstancesRequest.Builder avoiding the need to create one manually via ListInstancesRequest.builder()

      Parameters:
      listInstancesRequest - A Consumer that will call methods on ListInstancesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceNotFoundException No service exists with the specified ID.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamespaces

      default CompletableFuture<ListNamespacesResponse> listNamespaces(ListNamespacesRequest listNamespacesRequest)

      Lists summary information about the namespaces that were created by the current Amazon Web Services account.

      Parameters:
      listNamespacesRequest -
      Returns:
      A Java Future containing the result of the ListNamespaces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamespaces

      default CompletableFuture<ListNamespacesResponse> listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)

      Lists summary information about the namespaces that were created by the current Amazon Web Services account.


      This is a convenience which creates an instance of the ListNamespacesRequest.Builder avoiding the need to create one manually via ListNamespacesRequest.builder()

      Parameters:
      listNamespacesRequest - A Consumer that will call methods on ListNamespacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListNamespaces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamespaces

      default CompletableFuture<ListNamespacesResponse> listNamespaces()

      Lists summary information about the namespaces that were created by the current Amazon Web Services account.

      Returns:
      A Java Future containing the result of the ListNamespaces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamespacesPaginator

      default ListNamespacesPublisher listNamespacesPaginator()

      This is a variant of listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListNamespacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamespacesPaginator

      default ListNamespacesPublisher listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest)

      This is a variant of listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListNamespacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest) operation.

      Parameters:
      listNamespacesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamespacesPaginator

      default ListNamespacesPublisher listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)

      This is a variant of listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListNamespacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest) operation.


      This is a convenience which creates an instance of the ListNamespacesRequest.Builder avoiding the need to create one manually via ListNamespacesRequest.builder()

      Parameters:
      listNamespacesRequest - A Consumer that will call methods on ListNamespacesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOperations

      default CompletableFuture<ListOperationsResponse> listOperations(ListOperationsRequest listOperationsRequest)

      Lists operations that match the criteria that you specify.

      Parameters:
      listOperationsRequest -
      Returns:
      A Java Future containing the result of the ListOperations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOperations

      default CompletableFuture<ListOperationsResponse> listOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest)

      Lists operations that match the criteria that you specify.


      This is a convenience which creates an instance of the ListOperationsRequest.Builder avoiding the need to create one manually via ListOperationsRequest.builder()

      Parameters:
      listOperationsRequest - A Consumer that will call methods on ListOperationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListOperations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOperations

      default CompletableFuture<ListOperationsResponse> listOperations()

      Lists operations that match the criteria that you specify.

      Returns:
      A Java Future containing the result of the ListOperations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOperationsPaginator

      default ListOperationsPublisher listOperationsPaginator()

      This is a variant of listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListOperationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListOperationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOperationsPaginator

      default ListOperationsPublisher listOperationsPaginator(ListOperationsRequest listOperationsRequest)

      This is a variant of listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListOperationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListOperationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest) operation.

      Parameters:
      listOperationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOperationsPaginator

      default ListOperationsPublisher listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest)

      This is a variant of listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListOperationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListOperationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest) operation.


      This is a convenience which creates an instance of the ListOperationsRequest.Builder avoiding the need to create one manually via ListOperationsRequest.builder()

      Parameters:
      listOperationsRequest - A Consumer that will call methods on ListOperationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServices

      default CompletableFuture<ListServicesResponse> listServices(ListServicesRequest listServicesRequest)

      Lists summary information for all the services that are associated with one or more namespaces.

      Parameters:
      listServicesRequest -
      Returns:
      A Java Future containing the result of the ListServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServices

      default CompletableFuture<ListServicesResponse> listServices(Consumer<ListServicesRequest.Builder> listServicesRequest)

      Lists summary information for all the services that are associated with one or more namespaces.


      This is a convenience which creates an instance of the ListServicesRequest.Builder avoiding the need to create one manually via ListServicesRequest.builder()

      Parameters:
      listServicesRequest - A Consumer that will call methods on ListServicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServices

      default CompletableFuture<ListServicesResponse> listServices()

      Lists summary information for all the services that are associated with one or more namespaces.

      Returns:
      A Java Future containing the result of the ListServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServicesPaginator

      default ListServicesPublisher listServicesPaginator()

      This is a variant of listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListServicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListServicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServicesPaginator

      default ListServicesPublisher listServicesPaginator(ListServicesRequest listServicesRequest)

      This is a variant of listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListServicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListServicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) operation.

      Parameters:
      listServicesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServicesPaginator

      default ListServicesPublisher listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest)

      This is a variant of listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.servicediscovery.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.servicediscovery.model.ListServicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.servicediscovery.model.ListServicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) operation.


      This is a convenience which creates an instance of the ListServicesRequest.Builder avoiding the need to create one manually via ListServicesRequest.builder()

      Parameters:
      listServicesRequest - A Consumer that will call methods on ListServicesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists tags for the specified resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The operation can't be completed because the resource was not found.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists tags for the specified resource.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The operation can't be completed because the resource was not found.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerInstance

      default CompletableFuture<RegisterInstanceResponse> registerInstance(RegisterInstanceRequest registerInstanceRequest)

      Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs:

      • For each DNS record that you define in the service that's specified by ServiceId, a record is created or updated in the hosted zone that's associated with the corresponding namespace.

      • If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration.

      • The health check, if any, is associated with each of the new or updated records.

      One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID.

      For more information, see CreateService.

      When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

      • If the health check is healthy: returns all the records

      • If the health check is unhealthy: returns the applicable value for the last healthy instance

      • If you didn't specify a health check configuration: returns all the records

      For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.

      Parameters:
      registerInstanceRequest -
      Returns:
      A Java Future containing the result of the RegisterInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DuplicateRequestException The operation is already in progress.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • ResourceLimitExceededException The resource can't be created because you've reached the quota on the number of resources.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerInstance

      default CompletableFuture<RegisterInstanceResponse> registerInstance(Consumer<RegisterInstanceRequest.Builder> registerInstanceRequest)

      Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs:

      • For each DNS record that you define in the service that's specified by ServiceId, a record is created or updated in the hosted zone that's associated with the corresponding namespace.

      • If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration.

      • The health check, if any, is associated with each of the new or updated records.

      One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID.

      For more information, see CreateService.

      When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

      • If the health check is healthy: returns all the records

      • If the health check is unhealthy: returns the applicable value for the last healthy instance

      • If you didn't specify a health check configuration: returns all the records

      For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.


      This is a convenience which creates an instance of the RegisterInstanceRequest.Builder avoiding the need to create one manually via RegisterInstanceRequest.builder()

      Parameters:
      registerInstanceRequest - A Consumer that will call methods on RegisterInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DuplicateRequestException The operation is already in progress.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • ResourceLimitExceededException The resource can't be created because you've reached the quota on the number of resources.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds one or more tags to the specified resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The operation can't be completed because the resource was not found.
      • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds one or more tags to the specified resource.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The operation can't be completed because the resource was not found.
      • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes one or more tags from the specified resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The operation can't be completed because the resource was not found.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes one or more tags from the specified resource.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The operation can't be completed because the resource was not found.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateHttpNamespace

      default CompletableFuture<UpdateHttpNamespaceResponse> updateHttpNamespace(UpdateHttpNamespaceRequest updateHttpNamespaceRequest)

      Updates an HTTP namespace.

      Parameters:
      updateHttpNamespaceRequest -
      Returns:
      A Java Future containing the result of the UpdateHttpNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • DuplicateRequestException The operation is already in progress.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateHttpNamespace

      default CompletableFuture<UpdateHttpNamespaceResponse> updateHttpNamespace(Consumer<UpdateHttpNamespaceRequest.Builder> updateHttpNamespaceRequest)

      Updates an HTTP namespace.


      This is a convenience which creates an instance of the UpdateHttpNamespaceRequest.Builder avoiding the need to create one manually via UpdateHttpNamespaceRequest.builder()

      Parameters:
      updateHttpNamespaceRequest - A Consumer that will call methods on UpdateHttpNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateHttpNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • DuplicateRequestException The operation is already in progress.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInstanceCustomHealthStatus

      default CompletableFuture<UpdateInstanceCustomHealthStatusResponse> updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest updateInstanceCustomHealthStatusRequest)

      Submits a request to change the health status of a custom health check to healthy or unhealthy.

      You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig.

      For more information, see HealthCheckCustomConfig.

      Parameters:
      updateInstanceCustomHealthStatusRequest -
      Returns:
      A Java Future containing the result of the UpdateInstanceCustomHealthStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
      • ServiceNotFoundException No service exists with the specified ID.
      • CustomHealthNotFoundException The health check for the instance that's specified by ServiceId and InstanceId isn't a custom health check.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInstanceCustomHealthStatus

      default CompletableFuture<UpdateInstanceCustomHealthStatusResponse> updateInstanceCustomHealthStatus(Consumer<UpdateInstanceCustomHealthStatusRequest.Builder> updateInstanceCustomHealthStatusRequest)

      Submits a request to change the health status of a custom health check to healthy or unhealthy.

      You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig.

      For more information, see HealthCheckCustomConfig.


      This is a convenience which creates an instance of the UpdateInstanceCustomHealthStatusRequest.Builder avoiding the need to create one manually via UpdateInstanceCustomHealthStatusRequest.builder()

      Parameters:
      updateInstanceCustomHealthStatusRequest - A Consumer that will call methods on UpdateInstanceCustomHealthStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateInstanceCustomHealthStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
      • ServiceNotFoundException No service exists with the specified ID.
      • CustomHealthNotFoundException The health check for the instance that's specified by ServiceId and InstanceId isn't a custom health check.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePrivateDnsNamespace

      default CompletableFuture<UpdatePrivateDnsNamespaceResponse> updatePrivateDnsNamespace(UpdatePrivateDnsNamespaceRequest updatePrivateDnsNamespaceRequest)

      Updates a private DNS namespace.

      Parameters:
      updatePrivateDnsNamespaceRequest -
      Returns:
      A Java Future containing the result of the UpdatePrivateDnsNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • DuplicateRequestException The operation is already in progress.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePrivateDnsNamespace

      default CompletableFuture<UpdatePrivateDnsNamespaceResponse> updatePrivateDnsNamespace(Consumer<UpdatePrivateDnsNamespaceRequest.Builder> updatePrivateDnsNamespaceRequest)

      Updates a private DNS namespace.


      This is a convenience which creates an instance of the UpdatePrivateDnsNamespaceRequest.Builder avoiding the need to create one manually via UpdatePrivateDnsNamespaceRequest.builder()

      Parameters:
      updatePrivateDnsNamespaceRequest - A Consumer that will call methods on UpdatePrivateDnsNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePrivateDnsNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • DuplicateRequestException The operation is already in progress.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePublicDnsNamespace

      default CompletableFuture<UpdatePublicDnsNamespaceResponse> updatePublicDnsNamespace(UpdatePublicDnsNamespaceRequest updatePublicDnsNamespaceRequest)

      Updates a public DNS namespace.

      Parameters:
      updatePublicDnsNamespaceRequest -
      Returns:
      A Java Future containing the result of the UpdatePublicDnsNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • DuplicateRequestException The operation is already in progress.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePublicDnsNamespace

      default CompletableFuture<UpdatePublicDnsNamespaceResponse> updatePublicDnsNamespace(Consumer<UpdatePublicDnsNamespaceRequest.Builder> updatePublicDnsNamespaceRequest)

      Updates a public DNS namespace.


      This is a convenience which creates an instance of the UpdatePublicDnsNamespaceRequest.Builder avoiding the need to create one manually via UpdatePublicDnsNamespaceRequest.builder()

      Parameters:
      updatePublicDnsNamespaceRequest - A Consumer that will call methods on UpdatePublicDnsNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePublicDnsNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • NamespaceNotFoundException No namespace exists with the specified ID.
      • ResourceInUseException The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
      • DuplicateRequestException The operation is already in progress.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateService

      default CompletableFuture<UpdateServiceResponse> updateService(UpdateServiceRequest updateServiceRequest)

      Submits a request to perform the following operations:

      • Update the TTL setting for existing DnsRecords configurations

      • Add, update, or delete HealthCheckConfig for a specified service

        You can't add, update, or delete a HealthCheckCustomConfig configuration.

      For public and private DNS namespaces, note the following:

      • If you omit any existing DnsRecords or HealthCheckConfig configurations from an UpdateService request, the configurations are deleted from the service.

      • If you omit an existing HealthCheckCustomConfig configuration from an UpdateService request, the configuration isn't deleted from the service.

      When you update settings for a service, Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.

      Parameters:
      updateServiceRequest -
      Returns:
      A Java Future containing the result of the UpdateService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DuplicateRequestException The operation is already in progress.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateService

      default CompletableFuture<UpdateServiceResponse> updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest)

      Submits a request to perform the following operations:

      • Update the TTL setting for existing DnsRecords configurations

      • Add, update, or delete HealthCheckConfig for a specified service

        You can't add, update, or delete a HealthCheckCustomConfig configuration.

      For public and private DNS namespaces, note the following:

      • If you omit any existing DnsRecords or HealthCheckConfig configurations from an UpdateService request, the configurations are deleted from the service.

      • If you omit an existing HealthCheckCustomConfig configuration from an UpdateService request, the configuration isn't deleted from the service.

      When you update settings for a service, Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.


      This is a convenience which creates an instance of the UpdateServiceRequest.Builder avoiding the need to create one manually via UpdateServiceRequest.builder()

      Parameters:
      updateServiceRequest - A Consumer that will call methods on UpdateServiceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DuplicateRequestException The operation is already in progress.
      • InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
      • ServiceNotFoundException No service exists with the specified ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ServiceDiscoveryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default ServiceDiscoveryServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static ServiceDiscoveryAsyncClient create()
      Create a ServiceDiscoveryAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ServiceDiscoveryAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ServiceDiscoveryAsyncClient.