Class CreateBulkImportJobRequest

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

  • Method Details

    • jobName

      public final String jobName()

      The unique name that helps identify the job request.

      Returns:
      The unique name that helps identify the job request.

    • jobRoleArn

      public final String jobRoleArn()

      The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

      Returns:
      The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

    • hasFiles

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

    • files

      public final List<File> files()

      The files in the specified Amazon S3 bucket that contain your 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 hasFiles() method.

      Returns:
      The files in the specified Amazon S3 bucket that contain your data.

    • errorReportLocation

      public final ErrorReportLocation errorReportLocation()

      The Amazon S3 destination where errors associated with the job creation request are saved.

      Returns:
      The Amazon S3 destination where errors associated with the job creation request are saved.

    • jobConfiguration

      public final JobConfiguration jobConfiguration()

      Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

      Returns:
      Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

    • adaptiveIngestion

      public final Boolean adaptiveIngestion()

      If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.

      Returns:
      If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.

    • deleteFilesAfterImport

      public final Boolean deleteFilesAfterImport()

      If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.

      Returns:
      If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.

    • toBuilder

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

    • builder

      public static CreateBulkImportJobRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.