Package software.amazon.awssdk.services.comprehend.model

Class CreateDatasetRequest

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

  • Method Details

    • flywheelArn

      public final String flywheelArn()

      The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.

      Returns:
      The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.

    • datasetName

      public final String datasetName()

      Name of the dataset.

      Returns:
      Name of the dataset.

    • datasetType

      public final DatasetType datasetType()

      The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.

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

      Returns:
      The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.
      See Also:

    • datasetTypeAsString

      public final String datasetTypeAsString()

      The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.

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

      Returns:
      The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.
      See Also:

    • description

      public final String description()

      Description of the dataset.

      Returns:
      Description of the dataset.

    • inputDataConfig

      public final DatasetInputDataConfig inputDataConfig()

      Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.

      Returns:
      Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.

    • clientRequestToken

      public final String clientRequestToken()

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      Returns:
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

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

      Tags for the dataset.

      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:
      Tags for the dataset.

    • toBuilder

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

    • builder

      public static CreateDatasetRequest.Builder builder()

    • serializableBuilderClass

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