DatasetProperties (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.comprehend.model.DatasetProperties

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DatasetProperties
extends Object
implements Serializable, Cloneable, StructuredPojo

Properties associated with the dataset.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DatasetProperties()

Constructors
Constructor and Description
`DatasetProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DatasetProperties`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` Creation time of the dataset.
`String`	`getDatasetArn()` The ARN of the dataset.
`String`	`getDatasetName()` The name of the dataset.
`String`	`getDatasetS3Uri()` The S3 URI where the dataset is stored.
`String`	`getDatasetType()` The dataset type (training data or test data).
`String`	`getDescription()` Description of the dataset.
`Date`	`getEndTime()` Time when the data from the dataset becomes available in the data lake.
`String`	`getMessage()` A description of the status of the dataset.
`Long`	`getNumberOfDocuments()` The number of documents in the dataset.
`String`	`getStatus()` The dataset status.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` Creation time of the dataset.
`void`	`setDatasetArn(String datasetArn)` The ARN of the dataset.
`void`	`setDatasetName(String datasetName)` The name of the dataset.
`void`	`setDatasetS3Uri(String datasetS3Uri)` The S3 URI where the dataset is stored.
`void`	`setDatasetType(String datasetType)` The dataset type (training data or test data).
`void`	`setDescription(String description)` Description of the dataset.
`void`	`setEndTime(Date endTime)` Time when the data from the dataset becomes available in the data lake.
`void`	`setMessage(String message)` A description of the status of the dataset.
`void`	`setNumberOfDocuments(Long numberOfDocuments)` The number of documents in the dataset.
`void`	`setStatus(String status)` The dataset status.
`String`	`toString()` Returns a string representation of this object.
`DatasetProperties`	`withCreationTime(Date creationTime)` Creation time of the dataset.
`DatasetProperties`	`withDatasetArn(String datasetArn)` The ARN of the dataset.
`DatasetProperties`	`withDatasetName(String datasetName)` The name of the dataset.
`DatasetProperties`	`withDatasetS3Uri(String datasetS3Uri)` The S3 URI where the dataset is stored.
`DatasetProperties`	`withDatasetType(DatasetType datasetType)` The dataset type (training data or test data).
`DatasetProperties`	`withDatasetType(String datasetType)` The dataset type (training data or test data).
`DatasetProperties`	`withDescription(String description)` Description of the dataset.
`DatasetProperties`	`withEndTime(Date endTime)` Time when the data from the dataset becomes available in the data lake.
`DatasetProperties`	`withMessage(String message)` A description of the status of the dataset.
`DatasetProperties`	`withNumberOfDocuments(Long numberOfDocuments)` The number of documents in the dataset.
`DatasetProperties`	`withStatus(DatasetStatus status)` The dataset status.
`DatasetProperties`	`withStatus(String status)` The dataset status.

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

- Constructor Detail
  - DatasetProperties
```
public DatasetProperties()
```
- Method Detail
  - setDatasetArn
```
public void setDatasetArn(String datasetArn)
```
    The ARN of the dataset.
    
    Parameters:
    
    datasetArn - The ARN of the dataset.
  - getDatasetArn
```
public String getDatasetArn()
```
    The ARN of the dataset.
    
    Returns:
    
    The ARN of the dataset.
  - withDatasetArn
```
public DatasetProperties withDatasetArn(String datasetArn)
```
    The ARN of the dataset.
    
    Parameters:
    
    datasetArn - The ARN of the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatasetName
```
public void setDatasetName(String datasetName)
```
    The name of the dataset.
    
    Parameters:
    
    datasetName - The name of the dataset.
  - getDatasetName
```
public String getDatasetName()
```
    The name of the dataset.
    
    Returns:
    
    The name of the dataset.
  - withDatasetName
```
public DatasetProperties withDatasetName(String datasetName)
```
    The name of the dataset.
    
    Parameters:
    
    datasetName - The name of the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatasetType
```
public void setDatasetType(String datasetType)
```
    The dataset type (training data or test data).
    
    Parameters:
    
    datasetType - The dataset type (training data or test data).
    
    See Also:
    
    DatasetType
  - getDatasetType
```
public String getDatasetType()
```
    The dataset type (training data or test data).
    
    Returns:
    
    The dataset type (training data or test data).
    
    See Also:
    
    DatasetType
  - withDatasetType
```
public DatasetProperties withDatasetType(String datasetType)
```
    The dataset type (training data or test data).
    
    Parameters:
    
    datasetType - The dataset type (training data or test data).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DatasetType
  - withDatasetType
```
public DatasetProperties withDatasetType(DatasetType datasetType)
```
    The dataset type (training data or test data).
    
    Parameters:
    
    datasetType - The dataset type (training data or test data).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DatasetType
  - setDatasetS3Uri
```
public void setDatasetS3Uri(String datasetS3Uri)
```
    The S3 URI where the dataset is stored.
    
    Parameters:
    
    datasetS3Uri - The S3 URI where the dataset is stored.
  - getDatasetS3Uri
```
public String getDatasetS3Uri()
```
    The S3 URI where the dataset is stored.
    
    Returns:
    
    The S3 URI where the dataset is stored.
  - withDatasetS3Uri
```
public DatasetProperties withDatasetS3Uri(String datasetS3Uri)
```
    The S3 URI where the dataset is stored.
    
    Parameters:
    
    datasetS3Uri - The S3 URI where the dataset is stored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Description of the dataset.
    
    Parameters:
    
    description - Description of the dataset.
  - getDescription
```
public String getDescription()
```
    Description of the dataset.
    
    Returns:
    
    Description of the dataset.
  - withDescription
```
public DatasetProperties withDescription(String description)
```
    Description of the dataset.
    
    Parameters:
    
    description - Description of the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
    
    Parameters:
    
    status - The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
    
    See Also:
    
    DatasetStatus
  - getStatus
```
public String getStatus()
```
    The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
    
    Returns:
    
    The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
    
    See Also:
    
    DatasetStatus
  - withStatus
```
public DatasetProperties withStatus(String status)
```
    The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
    
    Parameters:
    
    status - The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DatasetStatus
  - withStatus
```
public DatasetProperties withStatus(DatasetStatus status)
```
    The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
    
    Parameters:
    
    status - The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DatasetStatus
  - setMessage
```
public void setMessage(String message)
```
    A description of the status of the dataset.
    
    Parameters:
    
    message - A description of the status of the dataset.
  - getMessage
```
public String getMessage()
```
    A description of the status of the dataset.
    
    Returns:
    
    A description of the status of the dataset.
  - withMessage
```
public DatasetProperties withMessage(String message)
```
    A description of the status of the dataset.
    
    Parameters:
    
    message - A description of the status of the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumberOfDocuments
```
public void setNumberOfDocuments(Long numberOfDocuments)
```
    The number of documents in the dataset.
    
    Parameters:
    
    numberOfDocuments - The number of documents in the dataset.
  - getNumberOfDocuments
```
public Long getNumberOfDocuments()
```
    The number of documents in the dataset.
    
    Returns:
    
    The number of documents in the dataset.
  - withNumberOfDocuments
```
public DatasetProperties withNumberOfDocuments(Long numberOfDocuments)
```
    The number of documents in the dataset.
    
    Parameters:
    
    numberOfDocuments - The number of documents in the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    Creation time of the dataset.
    
    Parameters:
    
    creationTime - Creation time of the dataset.
  - getCreationTime
```
public Date getCreationTime()
```
    Creation time of the dataset.
    
    Returns:
    
    Creation time of the dataset.
  - withCreationTime
```
public DatasetProperties withCreationTime(Date creationTime)
```
    Creation time of the dataset.
    
    Parameters:
    
    creationTime - Creation time of the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    Time when the data from the dataset becomes available in the data lake.
    
    Parameters:
    
    endTime - Time when the data from the dataset becomes available in the data lake.
  - getEndTime
```
public Date getEndTime()
```
    Time when the data from the dataset becomes available in the data lake.
    
    Returns:
    
    Time when the data from the dataset becomes available in the data lake.
  - withEndTime
```
public DatasetProperties withEndTime(Date endTime)
```
    Time when the data from the dataset becomes available in the data lake.
    
    Parameters:
    
    endTime - Time when the data from the dataset becomes available in the data lake.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 DatasetProperties 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.779

Class DatasetProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatasetProperties

Method Detail

setDatasetArn

getDatasetArn

withDatasetArn

setDatasetName

getDatasetName

withDatasetName

setDatasetType

getDatasetType

withDatasetType

withDatasetType

setDatasetS3Uri

getDatasetS3Uri

withDatasetS3Uri

setDescription

getDescription

withDescription

setStatus

getStatus

withStatus

withStatus

setMessage

getMessage

withMessage

setNumberOfDocuments

getNumberOfDocuments

withNumberOfDocuments

setCreationTime

getCreationTime

withCreationTime

setEndTime

getEndTime

withEndTime

toString

equals

hashCode

clone

marshall