ChannelSpecification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.ChannelSpecification

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ChannelSpecification
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Defines a named input source, called a channel, to be used by an algorithm.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ChannelSpecification()

Constructors
Constructor and Description
`ChannelSpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChannelSpecification`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A brief description of the channel.
`Boolean`	`getIsRequired()` Indicates whether the channel is required by the algorithm.
`String`	`getName()` The name of the channel.
`List<String>`	`getSupportedCompressionTypes()` The allowed compression types, if data compression is used.
`List<String>`	`getSupportedContentTypes()` The supported MIME types for the data.
`List<String>`	`getSupportedInputModes()` The allowed input mode, either FILE or PIPE.
`int`	`hashCode()`
`Boolean`	`isRequired()` Indicates whether the channel is required by the algorithm.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription(String description)` A brief description of the channel.
`void`	`setIsRequired(Boolean isRequired)` Indicates whether the channel is required by the algorithm.
`void`	`setName(String name)` The name of the channel.
`void`	`setSupportedCompressionTypes(Collection<String> supportedCompressionTypes)` The allowed compression types, if data compression is used.
`void`	`setSupportedContentTypes(Collection<String> supportedContentTypes)` The supported MIME types for the data.
`void`	`setSupportedInputModes(Collection<String> supportedInputModes)` The allowed input mode, either FILE or PIPE.
`String`	`toString()` Returns a string representation of this object.
`ChannelSpecification`	`withDescription(String description)` A brief description of the channel.
`ChannelSpecification`	`withIsRequired(Boolean isRequired)` Indicates whether the channel is required by the algorithm.
`ChannelSpecification`	`withName(String name)` The name of the channel.
`ChannelSpecification`	`withSupportedCompressionTypes(Collection<String> supportedCompressionTypes)` The allowed compression types, if data compression is used.
`ChannelSpecification`	`withSupportedCompressionTypes(CompressionType... supportedCompressionTypes)` The allowed compression types, if data compression is used.
`ChannelSpecification`	`withSupportedCompressionTypes(String... supportedCompressionTypes)` The allowed compression types, if data compression is used.
`ChannelSpecification`	`withSupportedContentTypes(Collection<String> supportedContentTypes)` The supported MIME types for the data.
`ChannelSpecification`	`withSupportedContentTypes(String... supportedContentTypes)` The supported MIME types for the data.
`ChannelSpecification`	`withSupportedInputModes(Collection<String> supportedInputModes)` The allowed input mode, either FILE or PIPE.
`ChannelSpecification`	`withSupportedInputModes(String... supportedInputModes)` The allowed input mode, either FILE or PIPE.
`ChannelSpecification`	`withSupportedInputModes(TrainingInputMode... supportedInputModes)` The allowed input mode, either FILE or PIPE.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ChannelSpecification
```
public ChannelSpecification()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the channel.
    
    Parameters:
    
    name - The name of the channel.
  - getName
```
public String getName()
```
    The name of the channel.
    
    Returns:
    
    The name of the channel.
  - withName
```
public ChannelSpecification withName(String name)
```
    The name of the channel.
    
    Parameters:
    
    name - The name of the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A brief description of the channel.
    
    Parameters:
    
    description - A brief description of the channel.
  - getDescription
```
public String getDescription()
```
    A brief description of the channel.
    
    Returns:
    
    A brief description of the channel.
  - withDescription
```
public ChannelSpecification withDescription(String description)
```
    A brief description of the channel.
    
    Parameters:
    
    description - A brief description of the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsRequired
```
public void setIsRequired(Boolean isRequired)
```
    Indicates whether the channel is required by the algorithm.
    
    Parameters:
    
    isRequired - Indicates whether the channel is required by the algorithm.
  - getIsRequired
```
public Boolean getIsRequired()
```
    Indicates whether the channel is required by the algorithm.
    
    Returns:
    
    Indicates whether the channel is required by the algorithm.
  - withIsRequired
```
public ChannelSpecification withIsRequired(Boolean isRequired)
```
    Indicates whether the channel is required by the algorithm.
    
    Parameters:
    
    isRequired - Indicates whether the channel is required by the algorithm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRequired
```
public Boolean isRequired()
```
    Indicates whether the channel is required by the algorithm.
    
    Returns:
    
    Indicates whether the channel is required by the algorithm.
  - getSupportedContentTypes
```
public List<String> getSupportedContentTypes()
```
    The supported MIME types for the data.
    
    Returns:
    
    The supported MIME types for the data.
  - setSupportedContentTypes
```
public void setSupportedContentTypes(Collection<String> supportedContentTypes)
```
    The supported MIME types for the data.
    
    Parameters:
    
    supportedContentTypes - The supported MIME types for the data.
  - withSupportedContentTypes
```
public ChannelSpecification withSupportedContentTypes(String... supportedContentTypes)
```
    The supported MIME types for the data.
    
    NOTE: This method appends the values to the existing list (if any). Use setSupportedContentTypes(java.util.Collection) or withSupportedContentTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    supportedContentTypes - The supported MIME types for the data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSupportedContentTypes
```
public ChannelSpecification withSupportedContentTypes(Collection<String> supportedContentTypes)
```
    The supported MIME types for the data.
    
    Parameters:
    
    supportedContentTypes - The supported MIME types for the data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSupportedCompressionTypes
```
public List<String> getSupportedCompressionTypes()
```
    The allowed compression types, if data compression is used.
    
    Returns:
    
    The allowed compression types, if data compression is used.
    
    See Also:
    
    CompressionType
  - setSupportedCompressionTypes
```
public void setSupportedCompressionTypes(Collection<String> supportedCompressionTypes)
```
    The allowed compression types, if data compression is used.
    
    Parameters:
    
    supportedCompressionTypes - The allowed compression types, if data compression is used.
    
    See Also:
    
    CompressionType
  - withSupportedCompressionTypes
```
public ChannelSpecification withSupportedCompressionTypes(String... supportedCompressionTypes)
```
    The allowed compression types, if data compression is used.
    
    NOTE: This method appends the values to the existing list (if any). Use setSupportedCompressionTypes(java.util.Collection) or withSupportedCompressionTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    supportedCompressionTypes - The allowed compression types, if data compression is used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CompressionType
  - withSupportedCompressionTypes
```
public ChannelSpecification withSupportedCompressionTypes(Collection<String> supportedCompressionTypes)
```
    The allowed compression types, if data compression is used.
    
    Parameters:
    
    supportedCompressionTypes - The allowed compression types, if data compression is used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CompressionType
  - withSupportedCompressionTypes
```
public ChannelSpecification withSupportedCompressionTypes(CompressionType... supportedCompressionTypes)
```
    The allowed compression types, if data compression is used.
    
    Parameters:
    
    supportedCompressionTypes - The allowed compression types, if data compression is used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CompressionType
  - getSupportedInputModes
```
public List<String> getSupportedInputModes()
```
    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.
    
    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.
    
    See Also:
    
    TrainingInputMode
  - setSupportedInputModes
```
public void setSupportedInputModes(Collection<String> 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    TrainingInputMode
  - withSupportedInputModes
```
public ChannelSpecification withSupportedInputModes(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSupportedInputModes(java.util.Collection) or withSupportedInputModes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingInputMode
  - withSupportedInputModes
```
public ChannelSpecification withSupportedInputModes(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingInputMode
  - withSupportedInputModes
```
public ChannelSpecification withSupportedInputModes(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingInputMode
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ChannelSpecification clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.771

Class ChannelSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChannelSpecification

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setIsRequired

getIsRequired

withIsRequired

isRequired

getSupportedContentTypes

setSupportedContentTypes

withSupportedContentTypes

withSupportedContentTypes

getSupportedCompressionTypes

setSupportedCompressionTypes

withSupportedCompressionTypes

withSupportedCompressionTypes

withSupportedCompressionTypes

getSupportedInputModes

setSupportedInputModes

withSupportedInputModes

withSupportedInputModes

withSupportedInputModes

toString

equals

hashCode

clone

marshall