Class GetRegistryRecordResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.agentregistrycontrol.model.AgentRegistryControlResponse
software.amazon.awssdk.services.agentregistrycontrol.model.GetRegistryRecordResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetRegistryRecordResponse.Builder,GetRegistryRecordResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetRegistryRecordResponse extends AgentRegistryControlResponse implements ToCopyableBuilder<GetRegistryRecordResponse.Builder,GetRegistryRecordResponse>

Response structure for retrieving a registry record

  • 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.

    • displayName

      public final String displayName()

      The human-readable display name of the registry record.

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

    • description

      public final String description()

      A description of the registry record.

      Returns:
      A description of the registry record.

    • recordType

      public final RecordType recordType()

      The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM.

      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, such as MCP, AGENT, SKILL, or CUSTOM.
      See Also:

    • recordTypeAsString

      public final String recordTypeAsString()

      The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM.

      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, such as MCP, AGENT, SKILL, or CUSTOM.
      See Also:

    • descriptors

      public final Descriptors descriptors()

      The typed descriptors that define the content of the registry record.

      Returns:
      The typed descriptors that define the content of the registry record.

    • 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.

      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.
      See Also:

    • statusAsString

      public final String statusAsString()

      The lifecycle status of the registry record.

      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.
      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.

    • statusReason

      public final String statusReason()

      The reason for the current status. Typically populated when the status indicates a failure state.

      Returns:
      The reason for the current status. Typically populated when the status indicates a failure state.

    • hasProvenance

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

    • provenance

      public final List<Provenance> provenance()
      Returns the value of the Provenance property for this object.

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

      Returns:
      The value of the Provenance property for this object.

    • createdByAutoDetection

      public final Boolean createdByAutoDetection()

      Specifies whether the registry record was created by auto-detection. true indicates the record was automatically created by the service based on the registry's auto-detection configuration; false indicates the record was created through a control-plane API call.

      Returns:
      Specifies whether the registry record was created by auto-detection. true indicates the record was automatically created by the service based on the registry's auto-detection configuration; false indicates the record was created through a control-plane API call.

    • createdBy

      public final String createdBy()

      The ID of the Amazon Web Services account that created the registry record.

      Returns:
      The ID of the Amazon Web Services account that created the registry record.

    • toBuilder

      public GetRegistryRecordResponse.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<GetRegistryRecordResponse.Builder,GetRegistryRecordResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetRegistryRecordResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.