Class PublicRecord
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PublicRecord.Builder,PublicRecord>
A public record returned by search. Only the record's public descriptors are included.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic PublicRecord.Builderbuilder()final InstantWhen the record was created.final StringA description of the record.final Map<String, DescriptorEntry> Every PUBLIC descriptor slot the record was published with, as published: each slot'ssource, inlinedata,versionand nestedadditionalData, thecustomslot included.final StringThe record's display name.final Stringdomain()Returns the value of the Domain property for this object.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the Descriptors property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the TrustManifests property.final IdentifierReturns the value of the Identifier property for this object.final RecordTypeThe kind of resource the record describes, such as an agent, a tool, or a skill.final StringThe kind of resource the record describes, such as an agent, a tool, or a skill.final StringThe record's version string, set by its publisher.static Class<? extends PublicRecord.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final List<TrustManifest> Trust Manifests (AI Catalog Trust Manifest Object), today only the registry's own,contributordid:web:agent-registry---global.api.aws.rproxy.goskope.com.final InstantWhen the record was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
identifier
Returns the value of the Identifier property for this object.- Returns:
- The value of the Identifier property for this object.
-
displayName
-
description
A description of the record.
- Returns:
- A description of the record.
-
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,
recordTypewill returnRecordType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrecordTypeAsString().- Returns:
- The kind of resource the record describes, such as an agent, a tool, or a skill.
- See Also:
-
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,
recordTypewill returnRecordType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrecordTypeAsString().- Returns:
- The kind of resource the record describes, such as an agent, a tool, or a skill.
- See Also:
-
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 theisEmpty()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
Every PUBLIC descriptor slot the record was published with, as published: each slot's
source, inlinedata,versionand nestedadditionalData, thecustomslot 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, inlinedata,versionand nestedadditionalData, thecustomslot 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 theisEmpty()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
Trust Manifests (AI Catalog Trust Manifest Object), today only the registry's own,
contributordid:web:agent-registry.global.api.aws. Its one provenance link says how the registry got the record:relationispublishedFromfor a record its owner published anddiscoveredFromfor one the registry discovered at a partner source, withsourceIdasProvenanceLink.sourceIddescribes. Theprovenancefilter takes the same values (seeProvenanceRelation). It's left off when the registry can't name the source: afederatedFromrecord 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,
contributordid:web:agent-registry.global.api.aws. Its one provenance link says how the registry got the record:relationispublishedFromfor a record its owner published anddiscoveredFromfor one the registry discovered at a partner source, withsourceIdasProvenanceLink.sourceIddescribes. Theprovenancefilter takes the same values (seeProvenanceRelation). It's left off when the registry can't name the source: afederatedFromrecord 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
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
-
updatedAt
When the record was last updated.
- Returns:
- When the record was last updated.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<PublicRecord.Builder,PublicRecord> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-