Class ChannelSpecification

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

Defines a named input source, called a channel, to be used by an algorithm.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the channel.

      Returns:
      The name of the channel.

    • description

      public final String description()

      A brief description of the channel.

      Returns:
      A brief description of the channel.

    • isRequired

      public final Boolean isRequired()

      Indicates whether the channel is required by the algorithm.

      Returns:
      Indicates whether the channel is required by the algorithm.

    • hasSupportedContentTypes

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

    • supportedContentTypes

      public final List<String> supportedContentTypes()

      The supported MIME types for the data.

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

      Returns:
      The supported MIME types for the data.

    • supportedCompressionTypes

      public final List<CompressionType> supportedCompressionTypes()

      The allowed compression types, if data compression is used.

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

      Returns:
      The allowed compression types, if data compression is used.

    • hasSupportedCompressionTypes

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

    • supportedCompressionTypesAsStrings

      public final List<String> supportedCompressionTypesAsStrings()

      The allowed compression types, if data compression is used.

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

      Returns:
      The allowed compression types, if data compression is used.

    • supportedInputModes

      public final List<TrainingInputMode> supportedInputModes()

      The allowed input mode, either FILE or PIPE.

      In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

      In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

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

      Returns:
      The allowed input mode, either FILE or PIPE.

      In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

      In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

    • hasSupportedInputModes

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

    • supportedInputModesAsStrings

      public final List<String> supportedInputModesAsStrings()

      The allowed input mode, either FILE or PIPE.

      In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

      In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

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

      Returns:
      The allowed input mode, either FILE or PIPE.

      In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

      In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

    • toBuilder

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

    • builder

      public static ChannelSpecification.Builder builder()

    • serializableBuilderClass

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