Package software.amazon.awssdk.services.honeycode.model

Class StartTableDataImportJobRequest

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

  • Method Details

    • workbookId

      public final String workbookId()

      The ID of the workbook where the rows are being imported.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

      Returns:
      The ID of the workbook where the rows are being imported.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • dataSource

      public final ImportDataSource dataSource()

      The source of the data that is being imported. The size of source must be no larger than 100 MB. Source must have no more than 100,000 cells and no more than 1,000 rows.

      Returns:
      The source of the data that is being imported. The size of source must be no larger than 100 MB. Source must have no more than 100,000 cells and no more than 1,000 rows.

    • dataFormat

      public final ImportSourceDataFormat dataFormat()

      The format of the data that is being imported. Currently the only option supported is "DELIMITED_TEXT".

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

      Returns:
      The format of the data that is being imported. Currently the only option supported is "DELIMITED_TEXT".
      See Also:

    • dataFormatAsString

      public final String dataFormatAsString()

      The format of the data that is being imported. Currently the only option supported is "DELIMITED_TEXT".

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

      Returns:
      The format of the data that is being imported. Currently the only option supported is "DELIMITED_TEXT".
      See Also:

    • destinationTableId

      public final String destinationTableId()

      The ID of the table where the rows are being imported.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

      Returns:
      The ID of the table where the rows are being imported.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

    • importOptions

      public final ImportOptions importOptions()

      The options for customizing this import request.

      Returns:
      The options for customizing this import request.

    • clientRequestToken

      public final String clientRequestToken()

      The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

      Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

      Returns:
      The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

      Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

    • toBuilder

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

    • builder

      public static StartTableDataImportJobRequest.Builder builder()

    • serializableBuilderClass

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