Interface AgentRegistryAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface AgentRegistryAsyncClient extends AwsClient
Service client for accessing Agent Registry 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.

Agent Registry lets callers discover, list, and retrieve approved records published to a registry.

  • Field Details

  • Method Details

    • batchGetDiscoverableRegistryRecord

      default CompletableFuture<BatchGetDiscoverableRegistryRecordResponse> batchGetDiscoverableRegistryRecord(BatchGetDiscoverableRegistryRecordRequest batchGetDiscoverableRegistryRecordRequest)

      Retrieves multiple discoverable registry records by ID from a single registry. Records that cannot be retrieved are reported individually in the errors list rather than failing the entire request.

      Parameters:
      batchGetDiscoverableRegistryRecordRequest -
      Returns:
      A Java Future containing the result of the BatchGetDiscoverableRegistryRecord 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.
      • InternalServerException The request failed due to an unexpected internal error; the caller may retry.
      • AccessDeniedException The caller is not authorized to perform the requested action.
      • ResourceNotFoundException The requested resource was not found.
      • ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
      • UnauthorizedException The request could not be authenticated.
      • ValidationException The request failed validation of one or more input fields.
      • 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.
      • AgentRegistryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetDiscoverableRegistryRecord

      default CompletableFuture<BatchGetDiscoverableRegistryRecordResponse> batchGetDiscoverableRegistryRecord(Consumer<BatchGetDiscoverableRegistryRecordRequest.Builder> batchGetDiscoverableRegistryRecordRequest)

      Retrieves multiple discoverable registry records by ID from a single registry. Records that cannot be retrieved are reported individually in the errors list rather than failing the entire request.


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

      Parameters:
      batchGetDiscoverableRegistryRecordRequest - A Consumer that will call methods on BatchGetDiscoverableRegistryRecordRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetDiscoverableRegistryRecord 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.
      • InternalServerException The request failed due to an unexpected internal error; the caller may retry.
      • AccessDeniedException The caller is not authorized to perform the requested action.
      • ResourceNotFoundException The requested resource was not found.
      • ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
      • UnauthorizedException The request could not be authenticated.
      • ValidationException The request failed validation of one or more input fields.
      • 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.
      • AgentRegistryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDiscoverableRegistryRecords

      default CompletableFuture<ListDiscoverableRegistryRecordsResponse> listDiscoverableRegistryRecords(ListDiscoverableRegistryRecordsRequest listDiscoverableRegistryRecordsRequest)

      Lists the discoverable registry records in a registry. You can optionally filter and paginate the results.

      Parameters:
      listDiscoverableRegistryRecordsRequest -
      Returns:
      A Java Future containing the result of the ListDiscoverableRegistryRecords 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.
      • InternalServerException The request failed due to an unexpected internal error; the caller may retry.
      • AccessDeniedException The caller is not authorized to perform the requested action.
      • ResourceNotFoundException The requested resource was not found.
      • ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
      • UnauthorizedException The request could not be authenticated.
      • ValidationException The request failed validation of one or more input fields.
      • 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.
      • AgentRegistryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDiscoverableRegistryRecords

      default CompletableFuture<ListDiscoverableRegistryRecordsResponse> listDiscoverableRegistryRecords(Consumer<ListDiscoverableRegistryRecordsRequest.Builder> listDiscoverableRegistryRecordsRequest)

      Lists the discoverable registry records in a registry. You can optionally filter and paginate the results.


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

      Parameters:
      listDiscoverableRegistryRecordsRequest - A Consumer that will call methods on ListDiscoverableRegistryRecordsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDiscoverableRegistryRecords 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.
      • InternalServerException The request failed due to an unexpected internal error; the caller may retry.
      • AccessDeniedException The caller is not authorized to perform the requested action.
      • ResourceNotFoundException The requested resource was not found.
      • ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
      • UnauthorizedException The request could not be authenticated.
      • ValidationException The request failed validation of one or more input fields.
      • 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.
      • AgentRegistryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDiscoverableRegistryRecordsPaginator

      default ListDiscoverableRegistryRecordsPublisher listDiscoverableRegistryRecordsPaginator(ListDiscoverableRegistryRecordsRequest listDiscoverableRegistryRecordsRequest)

      This is a variant of listDiscoverableRegistryRecords(software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsRequest) 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.agentregistry.paginators.ListDiscoverableRegistryRecordsPublisher publisher = client.listDiscoverableRegistryRecordsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.agentregistry.paginators.ListDiscoverableRegistryRecordsPublisher publisher = client.listDiscoverableRegistryRecordsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsResponse 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 listDiscoverableRegistryRecords(software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsRequest) operation.

      Parameters:
      listDiscoverableRegistryRecordsRequest -
      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.
      • InternalServerException The request failed due to an unexpected internal error; the caller may retry.
      • AccessDeniedException The caller is not authorized to perform the requested action.
      • ResourceNotFoundException The requested resource was not found.
      • ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
      • UnauthorizedException The request could not be authenticated.
      • ValidationException The request failed validation of one or more input fields.
      • 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.
      • AgentRegistryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDiscoverableRegistryRecordsPaginator

      default ListDiscoverableRegistryRecordsPublisher listDiscoverableRegistryRecordsPaginator(Consumer<ListDiscoverableRegistryRecordsRequest.Builder> listDiscoverableRegistryRecordsRequest)

      This is a variant of listDiscoverableRegistryRecords(software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsRequest) 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.agentregistry.paginators.ListDiscoverableRegistryRecordsPublisher publisher = client.listDiscoverableRegistryRecordsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.agentregistry.paginators.ListDiscoverableRegistryRecordsPublisher publisher = client.listDiscoverableRegistryRecordsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsResponse 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 listDiscoverableRegistryRecords(software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsRequest) operation.


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

      Parameters:
      listDiscoverableRegistryRecordsRequest - A Consumer that will call methods on ListDiscoverableRegistryRecordsRequest.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.
      • InternalServerException The request failed due to an unexpected internal error; the caller may retry.
      • AccessDeniedException The caller is not authorized to perform the requested action.
      • ResourceNotFoundException The requested resource was not found.
      • ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
      • UnauthorizedException The request could not be authenticated.
      • ValidationException The request failed validation of one or more input fields.
      • 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.
      • AgentRegistryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchDiscoverableRegistryRecords

      default CompletableFuture<SearchDiscoverableRegistryRecordsResponse> searchDiscoverableRegistryRecords(SearchDiscoverableRegistryRecordsRequest searchDiscoverableRegistryRecordsRequest)

      Searches the discoverable registry records in a registry using a natural language query. Returns metadata for the matching records ordered by relevance.

      Parameters:
      searchDiscoverableRegistryRecordsRequest -
      Returns:
      A Java Future containing the result of the SearchDiscoverableRegistryRecords 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.
      • InternalServerException The request failed due to an unexpected internal error; the caller may retry.
      • AccessDeniedException The caller is not authorized to perform the requested action.
      • ResourceNotFoundException The requested resource was not found.
      • ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
      • UnauthorizedException The request could not be authenticated.
      • ValidationException The request failed validation of one or more input fields.
      • 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.
      • AgentRegistryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchDiscoverableRegistryRecords

      default CompletableFuture<SearchDiscoverableRegistryRecordsResponse> searchDiscoverableRegistryRecords(Consumer<SearchDiscoverableRegistryRecordsRequest.Builder> searchDiscoverableRegistryRecordsRequest)

      Searches the discoverable registry records in a registry using a natural language query. Returns metadata for the matching records ordered by relevance.


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

      Parameters:
      searchDiscoverableRegistryRecordsRequest - A Consumer that will call methods on SearchDiscoverableRegistryRecordsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchDiscoverableRegistryRecords 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.
      • InternalServerException The request failed due to an unexpected internal error; the caller may retry.
      • AccessDeniedException The caller is not authorized to perform the requested action.
      • ResourceNotFoundException The requested resource was not found.
      • ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
      • UnauthorizedException The request could not be authenticated.
      • ValidationException The request failed validation of one or more input fields.
      • 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.
      • AgentRegistryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default AgentRegistryServiceClientConfiguration 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 AgentRegistryAsyncClient create()
      Create a AgentRegistryAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static AgentRegistryAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a AgentRegistryAsyncClient.