Class SearchPublicRecordsRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchPublicRecordsRequest.Builder,SearchPublicRecordsRequest>

@Generated("software.amazon.awssdk:codegen") public final class SearchPublicRecordsRequest extends AgentDiscoveryRequest implements ToCopyableBuilder<SearchPublicRecordsRequest.Builder,SearchPublicRecordsRequest>
  • Method Details

    • searchQuery

      public final String searchQuery()

      Free-text natural-language query (ARD text). Drives semantic + lexical ranking.

      Returns:
      Free-text natural-language query (ARD text). Drives semantic + lexical ranking.
    • filters

      public final Document filters()

      Structured filter narrowing the results, in the grammar of Agent Registry's SearchDiscoverableRegistryRecords filters: $eq, $ne and $in on a field, with $and or $or over single-condition objects, never nested. Fields are identifier, domain, recordType, descriptorType, provenance and recordVersion, and identifier also takes $prefix. For example {"recordType": {"$eq": "AGENT"}} or {"$or": [{"recordType": {"$eq": "MCP"}}, {"domain": {"$eq": "acme.com"}}]} .

      Limits, the same ones Agent Registry applies: at most 10 conditions, `$in` takes 1-25 values, values are strings of 1-512 characters, and `{}` is invalid. A `document` can't carry `@length`, so the service enforces these and answers a filter past them with a ValidationException, as Agent Registry does.

      Returns:
      Structured filter narrowing the results, in the grammar of Agent Registry's SearchDiscoverableRegistryRecords filters: $eq, $ne and $in on a field, with $and or $or over single-condition objects, never nested. Fields are identifier, domain, recordType, descriptorType, provenance and recordVersion, and identifier also takes $prefix. For example {"recordType": {"$eq": "AGENT"}} or {"$or": [{"recordType": {"$eq": "MCP"}}, {"domain": {"$eq": "acme.com"}}]} .

    • maxResults

      public final Integer maxResults()

      Max records per page. Default 20, max 100.

      Returns:
      Max records per page. Default 20, max 100.
    • nextToken

      public final String nextToken()

      Opaque composite-cursor pagination token (O-DM12).

      Returns:
      Opaque composite-cursor pagination token (O-DM12).
    • toBuilder

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchPublicRecordsRequest.Builder,SearchPublicRecordsRequest>
      Specified by:
      toBuilder in class AgentDiscoveryRequest
      Returns:
      a builder for type T
    • builder

      public static SearchPublicRecordsRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends SearchPublicRecordsRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.