Interface AgentRegistryClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface AgentRegistryClient
extends AwsClient

Service client for accessing Agent Registry. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchGetDiscoverableRegistryRecordResponse	batchGetDiscoverableRegistryRecord(Consumer<BatchGetDiscoverableRegistryRecordRequest.Builder> batchGetDiscoverableRegistryRecordRequest)	Retrieves multiple discoverable registry records by ID from a single registry.
default BatchGetDiscoverableRegistryRecordResponse	batchGetDiscoverableRegistryRecord(BatchGetDiscoverableRegistryRecordRequest batchGetDiscoverableRegistryRecordRequest)	Retrieves multiple discoverable registry records by ID from a single registry.
static AgentRegistryClientBuilder	builder()	Create a builder that can be used to configure and create a AgentRegistryClient.
static AgentRegistryClient	create()	Create a AgentRegistryClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default ListDiscoverableRegistryRecordsResponse	listDiscoverableRegistryRecords(Consumer<ListDiscoverableRegistryRecordsRequest.Builder> listDiscoverableRegistryRecordsRequest)	Lists the discoverable registry records in a registry.
default ListDiscoverableRegistryRecordsResponse	listDiscoverableRegistryRecords(ListDiscoverableRegistryRecordsRequest listDiscoverableRegistryRecordsRequest)	Lists the discoverable registry records in a registry.
default ListDiscoverableRegistryRecordsIterable	listDiscoverableRegistryRecordsPaginator(Consumer<ListDiscoverableRegistryRecordsRequest.Builder> listDiscoverableRegistryRecordsRequest)	This is a variant of listDiscoverableRegistryRecords(software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsRequest) operation.
default ListDiscoverableRegistryRecordsIterable	listDiscoverableRegistryRecordsPaginator(ListDiscoverableRegistryRecordsRequest listDiscoverableRegistryRecordsRequest)	This is a variant of listDiscoverableRegistryRecords(software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsRequest) operation.
default SearchDiscoverableRegistryRecordsResponse	searchDiscoverableRegistryRecords(Consumer<SearchDiscoverableRegistryRecordsRequest.Builder> searchDiscoverableRegistryRecordsRequest)	Searches the discoverable registry records in a registry using a natural language query.
default SearchDiscoverableRegistryRecordsResponse	searchDiscoverableRegistryRecords(SearchDiscoverableRegistryRecordsRequest searchDiscoverableRegistryRecordsRequest)	Searches the discoverable registry records in a registry using a natural language query.
default AgentRegistryServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

batchGetDiscoverableRegistryRecord

default BatchGetDiscoverableRegistryRecordResponse batchGetDiscoverableRegistryRecord(BatchGetDiscoverableRegistryRecordRequest batchGetDiscoverableRegistryRecordRequest)
                                                                               throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnauthorizedException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryException

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:

Result of the BatchGetDiscoverableRegistryRecord operation returned by the service.

See Also:

• AWS API Documentation

batchGetDiscoverableRegistryRecord

default BatchGetDiscoverableRegistryRecordResponse batchGetDiscoverableRegistryRecord(Consumer<BatchGetDiscoverableRegistryRecordRequest.Builder> batchGetDiscoverableRegistryRecordRequest)
                                                                               throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnauthorizedException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryException

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:

Result of the BatchGetDiscoverableRegistryRecord operation returned by the service.

See Also:

• AWS API Documentation

listDiscoverableRegistryRecords

default ListDiscoverableRegistryRecordsResponse listDiscoverableRegistryRecords(ListDiscoverableRegistryRecordsRequest listDiscoverableRegistryRecordsRequest)
                                                                         throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnauthorizedException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryException

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

Parameters:

listDiscoverableRegistryRecordsRequest -

Returns:

Result of the ListDiscoverableRegistryRecords operation returned by the service.

See Also:

• AWS API Documentation

listDiscoverableRegistryRecords

default ListDiscoverableRegistryRecordsResponse listDiscoverableRegistryRecords(Consumer<ListDiscoverableRegistryRecordsRequest.Builder> listDiscoverableRegistryRecordsRequest)
                                                                         throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnauthorizedException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryException

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:

Result of the ListDiscoverableRegistryRecords operation returned by the service.

See Also:

• AWS API Documentation

listDiscoverableRegistryRecordsPaginator

default ListDiscoverableRegistryRecordsIterable listDiscoverableRegistryRecordsPaginator(ListDiscoverableRegistryRecordsRequest listDiscoverableRegistryRecordsRequest)
                                                                                  throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnauthorizedException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryException

This is a variant of listDiscoverableRegistryRecords(software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.agentregistry.paginators.ListDiscoverableRegistryRecordsIterable responses = client.listDiscoverableRegistryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.agentregistry.paginators.ListDiscoverableRegistryRecordsIterable responses = client
             .listDiscoverableRegistryRecordsPaginator(request);
     for (software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.agentregistry.paginators.ListDiscoverableRegistryRecordsIterable responses = client.listDiscoverableRegistryRecordsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDiscoverableRegistryRecordsPaginator

default ListDiscoverableRegistryRecordsIterable listDiscoverableRegistryRecordsPaginator(Consumer<ListDiscoverableRegistryRecordsRequest.Builder> listDiscoverableRegistryRecordsRequest)
                                                                                  throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnauthorizedException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryException

This is a variant of listDiscoverableRegistryRecords(software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.agentregistry.paginators.ListDiscoverableRegistryRecordsIterable responses = client.listDiscoverableRegistryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.agentregistry.paginators.ListDiscoverableRegistryRecordsIterable responses = client
             .listDiscoverableRegistryRecordsPaginator(request);
     for (software.amazon.awssdk.services.agentregistry.model.ListDiscoverableRegistryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.agentregistry.paginators.ListDiscoverableRegistryRecordsIterable responses = client.listDiscoverableRegistryRecordsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchDiscoverableRegistryRecords

default SearchDiscoverableRegistryRecordsResponse searchDiscoverableRegistryRecords(SearchDiscoverableRegistryRecordsRequest searchDiscoverableRegistryRecordsRequest)
                                                                             throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnauthorizedException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryException

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:

Result of the SearchDiscoverableRegistryRecords operation returned by the service.

See Also:

• AWS API Documentation

searchDiscoverableRegistryRecords

default SearchDiscoverableRegistryRecordsResponse searchDiscoverableRegistryRecords(Consumer<SearchDiscoverableRegistryRecordsRequest.Builder> searchDiscoverableRegistryRecordsRequest)
                                                                             throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnauthorizedException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryException

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:

Result of the SearchDiscoverableRegistryRecords operation returned by the service.

See Also:

• AWS API Documentation

create

static AgentRegistryClient create()

Create a AgentRegistryClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static AgentRegistryClientBuilder builder()

Create a builder that can be used to configure and create a AgentRegistryClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

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