Class UpdateHubContentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
software.amazon.awssdk.services.sagemaker.model.UpdateHubContentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateHubContentRequest.Builder,UpdateHubContentRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateHubContentRequest extends SageMakerRequest implements ToCopyableBuilder<UpdateHubContentRequest.Builder,UpdateHubContentRequest>

  • Method Details

    • hubName

      public final String hubName()

      The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead.

      Returns:
      The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead.

    • hubContentName

      public final String hubContentName()

      The name of the hub content resource that you want to update.

      Returns:
      The name of the hub content resource that you want to update.

    • hubContentType

      public final HubContentType hubContentType()

      The content type of the resource that you want to update. Only specify a Model or Notebook resource for this API. To update a ModelReference, use the UpdateHubContentReference API instead.

      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 content type of the resource that you want to update. Only specify a Model or Notebook resource for this API. To update a ModelReference, use the UpdateHubContentReference API instead.
      See Also:

    • hubContentTypeAsString

      public final String hubContentTypeAsString()

      The content type of the resource that you want to update. Only specify a Model or Notebook resource for this API. To update a ModelReference, use the UpdateHubContentReference API instead.

      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 content type of the resource that you want to update. Only specify a Model or Notebook resource for this API. To update a ModelReference, use the UpdateHubContentReference API instead.
      See Also:

    • hubContentVersion

      public final String hubContentVersion()

      The hub content version that you want to update. For example, if you have two versions of a resource in your hub, you can update the second version.

      Returns:
      The hub content version that you want to update. For example, if you have two versions of a resource in your hub, you can update the second version.

    • 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()

      The description of the hub content.

      Returns:
      The 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.

    • 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 of 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 of the hub content.

    • supportStatus

      public final HubContentSupportStatus supportStatus()

      Indicates the current status of the hub content resource.

      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:
      Indicates the current status of the hub content resource.
      See Also:

    • supportStatusAsString

      public final String supportStatusAsString()

      Indicates the current status of the hub content resource.

      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:
      Indicates the current status of the hub content resource.
      See Also:

    • toBuilder

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

    • builder

      public static UpdateHubContentRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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