Package software.amazon.awssdk.services.iotsitewise.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateBulkImportJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	adaptiveIngestion()	If set to true, ingest new data into IoT SiteWise storage.
static CreateBulkImportJobRequest.Builder	builder()
Boolean	deleteFilesAfterImport()	If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorReportLocation	errorReportLocation()	The Amazon S3 destination where errors associated with the job creation request are saved.
List<File>	files()	The files in the specified Amazon S3 bucket that contain your data.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFiles()	For responses, this returns true if the service returned a value for the Files property.
int	hashCode()
JobConfiguration	jobConfiguration()	Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
String	jobName()	The unique name that helps identify the job request.
String	jobRoleArn()	The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBulkImportJobRequest.Builder>	serializableBuilderClass()
CreateBulkImportJobRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBulkImportJobRequest.Builder,CreateBulkImportJobRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo