Class HubContent

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

Contains information about a hub content resource, including its name, version, type, associated documents, dependencies, and status, as returned by a search result.

See Also:

  • Method Details

    • hubContentName

      public final String hubContentName()

      The name of the hub content.

      Returns:
      The name of the hub content.

    • hubContentArn

      public final String hubContentArn()

      The Amazon Resource Name (ARN) of the hub content.

      Returns:
      The Amazon Resource Name (ARN) of the hub content.

    • hubContentVersion

      public final String hubContentVersion()

      The version of the hub content.

      Returns:
      The version of the hub content.

    • hubContentType

      public final HubContentType hubContentType()

      The type of hub content.

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

      Returns:
      The type of hub content.
      See Also:

    • hubContentTypeAsString

      public final String hubContentTypeAsString()

      The type of hub content.

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

      Returns:
      The type of hub content.
      See Also:

    • documentSchemaVersion

      public final String documentSchemaVersion()

      The document schema version for the hub content.

      Returns:
      The document schema version for the hub content.

    • hubName

      public final String hubName()

      The name of the hub that contains the content.

      Returns:
      The name of the hub that contains the content.

    • hubArn

      public final String hubArn()

      The Amazon Resource Name (ARN) of the hub that contains the content.

      Returns:
      The Amazon Resource Name (ARN) of the hub that contains the content.

    • hubContentDisplayName

      public final String hubContentDisplayName()

      The display name of the hub content.

      Returns:
      The display name of the hub content.

    • hubContentDescription

      public final String hubContentDescription()

      A description of the hub content.

      Returns:
      A description of the hub content.

    • hubContentMarkdown

      public final String hubContentMarkdown()

      A string that provides a description of the hub content. This string can include links, tables, and standard markdown formatting.

      Returns:
      A string that provides a description of the hub content. This string can include links, tables, and standard markdown formatting.

    • hubContentDocument

      public final String hubContentDocument()

      The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

      Returns:
      The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

    • sageMakerPublicHubContentArn

      public final String sageMakerPublicHubContentArn()

      The Amazon Resource Name (ARN) of the public hub content.

      Returns:
      The Amazon Resource Name (ARN) of the public hub content.

    • referenceMinVersion

      public final String referenceMinVersion()

      The minimum version of the hub content.

      Returns:
      The minimum version of the hub content.

    • supportStatus

      public final HubContentSupportStatus supportStatus()

      The support status of the hub content.

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

      Returns:
      The support status of the hub content.
      See Also:

    • supportStatusAsString

      public final String supportStatusAsString()

      The support status of the hub content.

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

      Returns:
      The support status of the hub content.
      See Also:

    • hasHubContentSearchKeywords

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

    • hubContentSearchKeywords

      public final List<String> hubContentSearchKeywords()

      The searchable keywords for the hub content.

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

      Returns:
      The searchable keywords for the hub content.

    • hasHubContentDependencies

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

    • hubContentDependencies

      public final List<HubContentDependency> hubContentDependencies()

      The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

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

      Returns:
      The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

    • hubContentStatus

      public final HubContentStatus hubContentStatus()

      The status of the hub content.

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

      Returns:
      The status of the hub content.
      See Also:

    • hubContentStatusAsString

      public final String hubContentStatusAsString()

      The status of the hub content.

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

      Returns:
      The status of the hub content.
      See Also:

    • failureReason

      public final String failureReason()

      The failure reason if importing hub content failed.

      Returns:
      The failure reason if importing hub content failed.

    • creationTime

      public final Instant creationTime()

      The date and time that hub content was created.

      Returns:
      The date and time that hub content was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The last modified time of the hub content.

      Returns:
      The last modified time of the hub content.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      Any tags associated with the hub content.

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

      Returns:
      Any tags associated with the hub content.

    • toBuilder

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

    • builder

      public static HubContent.Builder builder()

    • serializableBuilderClass

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