Class DiscoverableRegistryRecordSummary

java.lang.Object
software.amazon.awssdk.services.agentregistry.model.DiscoverableRegistryRecordSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DiscoverableRegistryRecordSummary.Builder,DiscoverableRegistryRecordSummary>
@Generated("software.amazon.awssdk:codegen") public final class DiscoverableRegistryRecordSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DiscoverableRegistryRecordSummary.Builder,DiscoverableRegistryRecordSummary>

Summary information about a discoverable registry record returned by ListDiscoverableRegistryRecords. This summary does not include descriptors.

See Also:

  • Method Details

    • registryArn

      public final String registryArn()

      The Amazon Resource Name (ARN) of the parent registry that owns the record.

      Returns:
      The Amazon Resource Name (ARN) of the parent registry that owns the record.

    • recordArn

      public final String recordArn()

      The Amazon Resource Name (ARN) of the registry record.

      Returns:
      The Amazon Resource Name (ARN) of the registry record.

    • recordId

      public final String recordId()

      The unique identifier of the registry record.

      Returns:
      The unique identifier of the registry record.

    • name

      public final String name()

      The name of the registry record. Names are unique within a registry.

      Returns:
      The name of the registry record. Names are unique within a registry.

    • description

      public final String description()

      A human-readable description of the registry record. Use this field to explain the record's purpose or content to consumers discovering it in the registry.

      Returns:
      A human-readable description of the registry record. Use this field to explain the record's purpose or content to consumers discovering it in the registry.

    • displayName

      public final String displayName()

      The human-readable display name of the registry record.

      Returns:
      The human-readable display name of the registry record.

    • recordType

      public final RecordType recordType()

      The type of the registry record. MCP is a Model Context Protocol server record, AGENT is an Agent-to-Agent (A2A) agent card record, SKILL is an agent skills definition record, and CUSTOM is a record with a custom descriptor.

      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 type of the registry record. MCP is a Model Context Protocol server record, AGENT is an Agent-to-Agent (A2A) agent card record, SKILL is an agent skills definition record, and CUSTOM is a record with a custom descriptor.
      See Also:

    • recordTypeAsString

      public final String recordTypeAsString()

      The type of the registry record. MCP is a Model Context Protocol server record, AGENT is an Agent-to-Agent (A2A) agent card record, SKILL is an agent skills definition record, and CUSTOM is a record with a custom descriptor.

      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 type of the registry record. MCP is a Model Context Protocol server record, AGENT is an Agent-to-Agent (A2A) agent card record, SKILL is an agent skills definition record, and CUSTOM is a record with a custom descriptor.
      See Also:

    • recordVersion

      public final String recordVersion()

      The version identifier of the registry record.

      Returns:
      The version identifier of the registry record.

    • status

      public final RegistryRecordStatus status()

      The lifecycle status of the registry record. A record is DRAFT before it is submitted, PENDING_APPROVAL while awaiting curator review, and APPROVED once it is approved and discoverable. REJECTED and DEPRECATED records are not discoverable. The CREATING, UPDATING, CREATE_FAILED, and UPDATE_FAILED values reflect the state of an in-progress or failed asynchronous change.

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

      Returns:
      The lifecycle status of the registry record. A record is DRAFT before it is submitted, PENDING_APPROVAL while awaiting curator review, and APPROVED once it is approved and discoverable. REJECTED and DEPRECATED records are not discoverable. The CREATING, UPDATING, CREATE_FAILED, and UPDATE_FAILED values reflect the state of an in-progress or failed asynchronous change.
      See Also:

    • statusAsString

      public final String statusAsString()

      The lifecycle status of the registry record. A record is DRAFT before it is submitted, PENDING_APPROVAL while awaiting curator review, and APPROVED once it is approved and discoverable. REJECTED and DEPRECATED records are not discoverable. The CREATING, UPDATING, CREATE_FAILED, and UPDATE_FAILED values reflect the state of an in-progress or failed asynchronous change.

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

      Returns:
      The lifecycle status of the registry record. A record is DRAFT before it is submitted, PENDING_APPROVAL while awaiting curator review, and APPROVED once it is approved and discoverable. REJECTED and DEPRECATED records are not discoverable. The CREATING, UPDATING, CREATE_FAILED, and UPDATE_FAILED values reflect the state of an in-progress or failed asynchronous change.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the registry record was created.

      Returns:
      The timestamp when the registry record was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the registry record was last updated.

      Returns:
      The timestamp when the registry record was last updated.

    • hasDescriptorTypes

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

    • descriptorTypes

      public final List<String> descriptorTypes()

      The descriptor types that are present on this registry record. Each value corresponds to a descriptor entry key on the approved record.

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

      Returns:
      The descriptor types that are present on this registry record. Each value corresponds to a descriptor entry key on the approved record.

    • toBuilder

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

    • builder

      public static DiscoverableRegistryRecordSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DiscoverableRegistryRecordSummary.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.