Package software.amazon.awssdk.services.bedrockagentcore.model

Class SearchRegistryRecordsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.SearchRegistryRecordsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchRegistryRecordsRequest.Builder,SearchRegistryRecordsRequest>
@Generated("software.amazon.awssdk:codegen") public final class SearchRegistryRecordsRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<SearchRegistryRecordsRequest.Builder,SearchRegistryRecordsRequest>

  • Method Details

    • searchQuery

      public final String searchQuery()

      The search query to find matching registry records.

      Returns:
      The search query to find matching registry records.

    • hasRegistryIds

      public final boolean hasRegistryIds()
      For responses, this returns true if the service returned a value for the RegistryIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • registryIds

      public final List<String> registryIds()

      The list of registry identifiers to search within. Currently, you can specify exactly one registry identifier. You can provide either the full Amazon Web Services Resource Name (ARN) or the 12-character alphanumeric registry ID.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRegistryIds() method.

      Returns:
      The list of registry identifiers to search within. Currently, you can specify exactly one registry identifier. You can provide either the full Amazon Web Services Resource Name (ARN) or the 12-character alphanumeric registry ID.

    • maxResults

      public final Integer maxResults()

      The maximum number of records to return in a single call. Valid values are 1 through 20. The default value is 10.

      Returns:
      The maximum number of records to return in a single call. Valid values are 1 through 20. The default value is 10.

    • filters

      public final Document filters()

      A metadata filter expression to narrow search results. Uses structured JSON operators including field-level operators ($eq, $ne, $in) and logical operators ($and, $or) on filterable fields (name, descriptorType, version). For example, to filter by descriptor type: {"descriptorType": {"$eq": "MCP"}}. To combine filters: {"$and": [{"descriptorType": {"$eq": "MCP"}}, {"name": {"$eq": "my-tool"}}]}.

      Returns:
      A metadata filter expression to narrow search results. Uses structured JSON operators including field-level operators ($eq, $ne, $in) and logical operators ( $and, $or) on filterable fields (name, descriptorType , version). For example, to filter by descriptor type: {"descriptorType": {"$eq": "MCP"}}. To combine filters: {"$and": [{"descriptorType": {"$eq": "MCP"}}, {"name": {"$eq": "my-tool"}}]}.

    • toBuilder

      public SearchRegistryRecordsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchRegistryRecordsRequest.Builder,SearchRegistryRecordsRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest

    • builder

      public static SearchRegistryRecordsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchRegistryRecordsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo