Class DescribeBulkImportJobResponse

    • Method Detail

      • jobId

        public final String jobId()

        The ID of the job.

        Returns:
        The ID of the job.
      • jobName

        public final String jobName()

        The unique name that helps identify the job request.

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

        public final JobStatus jobStatus()

        The status of the bulk import job can be one of following values:

        • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

        • CANCELLED – The bulk import job has been canceled.

        • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

        • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

        • FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

        • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

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

        Returns:
        The status of the bulk import job can be one of following values:

        • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

        • CANCELLED – The bulk import job has been canceled.

        • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

        • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

        • FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

        • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

        See Also:
        JobStatus
      • jobStatusAsString

        public final String jobStatusAsString()

        The status of the bulk import job can be one of following values:

        • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

        • CANCELLED – The bulk import job has been canceled.

        • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

        • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

        • FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

        • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

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

        Returns:
        The status of the bulk import job can be one of following values:

        • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

        • CANCELLED – The bulk import job has been canceled.

        • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

        • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

        • FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

        • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

        See Also:
        JobStatus
      • 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.
      • jobCreationDate

        public final Instant jobCreationDate()

        The date the job was created, in Unix epoch TIME.

        Returns:
        The date the job was created, in Unix epoch TIME.
      • jobLastUpdateDate

        public final Instant jobLastUpdateDate()

        The date the job was last updated, in Unix epoch time.

        Returns:
        The date the job was last updated, in Unix epoch time.
      • 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.
      • 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