Class PublicRecord

java.lang.Object
software.amazon.awssdk.services.agentdiscovery.model.PublicRecord
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PublicRecord.Builder,PublicRecord>

@Generated("software.amazon.awssdk:codegen") public final class PublicRecord extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PublicRecord.Builder,PublicRecord>

A public record returned by search. Only the record's public descriptors are included.

See Also:
  • Method Details

    • identifier

      public final Identifier identifier()
      Returns the value of the Identifier property for this object.
      Returns:
      The value of the Identifier property for this object.
    • displayName

      public final String displayName()

      The record's display name.

      Returns:
      The record's display name.
    • description

      public final String description()

      A description of the record.

      Returns:
      A description of the record.
    • recordType

      public final RecordType recordType()

      The kind of resource the record describes, such as an agent, a tool, or a skill.

      If the service returns an enum value that is not available in the current SDK version, recordType will return RecordType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recordTypeAsString().

      Returns:
      The kind of resource the record describes, such as an agent, a tool, or a skill.
      See Also:
    • recordTypeAsString

      public final String recordTypeAsString()

      The kind of resource the record describes, such as an agent, a tool, or a skill.

      If the service returns an enum value that is not available in the current SDK version, recordType will return RecordType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recordTypeAsString().

      Returns:
      The kind of resource the record describes, such as an agent, a tool, or a skill.
      See Also:
    • domain

      public final String domain()
      Returns the value of the Domain property for this object.
      Returns:
      The value of the Domain property for this object.
    • hasDescriptors

      public final boolean hasDescriptors()
      For responses, this returns true if the service returned a value for the Descriptors 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.
    • descriptors

      public final Map<String,DescriptorEntry> descriptors()

      Every PUBLIC descriptor slot the record was published with, as published: each slot's source, inline data, version and nested additionalData, the custom slot included. Absent on a record discovered at a partner source; ARD serves the partner's cards.

      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 hasDescriptors() method.

      Returns:
      Every PUBLIC descriptor slot the record was published with, as published: each slot's source , inline data, version and nested additionalData, the custom slot included. Absent on a record discovered at a partner source; ARD serves the partner's cards.
    • hasTrustManifests

      public final boolean hasTrustManifests()
      For responses, this returns true if the service returned a value for the TrustManifests 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.
    • trustManifests

      public final List<TrustManifest> trustManifests()

      Trust Manifests (AI Catalog Trust Manifest Object), today only the registry's own, contributor did:web:agent-registry.global.api.aws. Its one provenance link says how the registry got the record: relation is publishedFrom for a record its owner published and discoveredFrom for one the registry discovered at a partner source, with sourceId as ProvenanceLink.sourceId describes. The provenance filter takes the same values (see ProvenanceRelation). It's left off when the registry can't name the source: a federatedFrom record until the index carries the peer registry, a discovered record with no source, or a missing or unknown origin. The manifest is unsigned, so it attributes the claim to the registry and doesn't authenticate it.

      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 hasTrustManifests() method.

      Returns:
      Trust Manifests (AI Catalog Trust Manifest Object), today only the registry's own, contributor did:web:agent-registry.global.api.aws. Its one provenance link says how the registry got the record: relation is publishedFrom for a record its owner published and discoveredFrom for one the registry discovered at a partner source, with sourceId as ProvenanceLink.sourceId describes. The provenance filter takes the same values (see ProvenanceRelation). It's left off when the registry can't name the source: a federatedFrom record until the index carries the peer registry, a discovered record with no source, or a missing or unknown origin. The manifest is unsigned, so it attributes the claim to the registry and doesn't authenticate it.
    • recordVersion

      public final String recordVersion()

      The record's version string, set by its publisher. Left off when the record has none, for example a discovered record whose source carries no version.

      Returns:
      The record's version string, set by its publisher. Left off when the record has none, for example a discovered record whose source carries no version.
    • createdAt

      public final Instant createdAt()

      When the record was created.

      Returns:
      When the record was created.
    • updatedAt

      public final Instant updatedAt()

      When the record was last updated.

      Returns:
      When the record was last updated.
    • toBuilder

      public PublicRecord.Builder 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<PublicRecord.Builder,PublicRecord>
      Returns:
      a builder for type T
    • builder

      public static PublicRecord.Builder builder()
    • serializableBuilderClass

      public static Class<? extends PublicRecord.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.