Interface DescribeBulkImportJobResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<DescribeBulkImportJobResponse.Builder,DescribeBulkImportJobResponse>,IoTSiteWiseResponse.Builder,SdkBuilder<DescribeBulkImportJobResponse.Builder,DescribeBulkImportJobResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- DescribeBulkImportJobResponse
public static interface DescribeBulkImportJobResponse.Builder extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<DescribeBulkImportJobResponse.Builder,DescribeBulkImportJobResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DescribeBulkImportJobResponse.BuilderadaptiveIngestion(Boolean adaptiveIngestion)If set to true, ingest new data into IoT SiteWise storage.DescribeBulkImportJobResponse.BuilderdeleteFilesAfterImport(Boolean deleteFilesAfterImport)If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.default DescribeBulkImportJobResponse.BuildererrorReportLocation(Consumer<ErrorReportLocation.Builder> errorReportLocation)The Amazon S3 destination where errors associated with the job creation request are saved.DescribeBulkImportJobResponse.BuildererrorReportLocation(ErrorReportLocation errorReportLocation)The Amazon S3 destination where errors associated with the job creation request are saved.DescribeBulkImportJobResponse.Builderfiles(Collection<File> files)The files in the specified Amazon S3 bucket that contain your data.DescribeBulkImportJobResponse.Builderfiles(Consumer<File.Builder>... files)The files in the specified Amazon S3 bucket that contain your data.DescribeBulkImportJobResponse.Builderfiles(File... files)The files in the specified Amazon S3 bucket that contain your data.default DescribeBulkImportJobResponse.BuilderjobConfiguration(Consumer<JobConfiguration.Builder> jobConfiguration)Contains the configuration information of a job, such as the file format used to save data in Amazon S3.DescribeBulkImportJobResponse.BuilderjobConfiguration(JobConfiguration jobConfiguration)Contains the configuration information of a job, such as the file format used to save data in Amazon S3.DescribeBulkImportJobResponse.BuilderjobCreationDate(Instant jobCreationDate)The date the job was created, in Unix epoch TIME.DescribeBulkImportJobResponse.BuilderjobId(String jobId)The ID of the job.DescribeBulkImportJobResponse.BuilderjobLastUpdateDate(Instant jobLastUpdateDate)The date the job was last updated, in Unix epoch time.DescribeBulkImportJobResponse.BuilderjobName(String jobName)The unique name that helps identify the job request.DescribeBulkImportJobResponse.BuilderjobRoleArn(String jobRoleArn)The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.DescribeBulkImportJobResponse.BuilderjobStatus(String jobStatus)The status of the bulk import job can be one of following values:DescribeBulkImportJobResponse.BuilderjobStatus(JobStatus jobStatus)The status of the bulk import job can be one of following values:-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
jobId
DescribeBulkImportJobResponse.Builder jobId(String jobId)
The ID of the job.
- Parameters:
jobId- The ID of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobName
DescribeBulkImportJobResponse.Builder jobName(String jobName)
The unique name that helps identify the job request.
- Parameters:
jobName- The unique name that helps identify the job request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobStatus
DescribeBulkImportJobResponse.Builder jobStatus(String 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
JobStatus,JobStatus
-
-
jobStatus
DescribeBulkImportJobResponse.Builder jobStatus(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
JobStatus,JobStatus
-
-
jobRoleArn
DescribeBulkImportJobResponse.Builder jobRoleArn(String jobRoleArn)
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
- Parameters:
jobRoleArn- The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
files
DescribeBulkImportJobResponse.Builder files(Collection<File> files)
The files in the specified Amazon S3 bucket that contain your data.
- Parameters:
files- The files in the specified Amazon S3 bucket that contain your data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
files
DescribeBulkImportJobResponse.Builder files(File... files)
The files in the specified Amazon S3 bucket that contain your data.
- Parameters:
files- The files in the specified Amazon S3 bucket that contain your data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
files
DescribeBulkImportJobResponse.Builder files(Consumer<File.Builder>... files)
The files in the specified Amazon S3 bucket that contain your data.
This is a convenience method that creates an instance of theFile.Builderavoiding the need to create one manually viaFile.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#files(List.) - Parameters:
files- a consumer that will call methods onFile.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#files(java.util.Collection)
-
errorReportLocation
DescribeBulkImportJobResponse.Builder errorReportLocation(ErrorReportLocation errorReportLocation)
The Amazon S3 destination where errors associated with the job creation request are saved.
- Parameters:
errorReportLocation- The Amazon S3 destination where errors associated with the job creation request are saved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errorReportLocation
default DescribeBulkImportJobResponse.Builder errorReportLocation(Consumer<ErrorReportLocation.Builder> errorReportLocation)
The Amazon S3 destination where errors associated with the job creation request are saved.
This is a convenience method that creates an instance of theErrorReportLocation.Builderavoiding the need to create one manually viaErrorReportLocation.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toerrorReportLocation(ErrorReportLocation).- Parameters:
errorReportLocation- a consumer that will call methods onErrorReportLocation.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
errorReportLocation(ErrorReportLocation)
-
jobConfiguration
DescribeBulkImportJobResponse.Builder jobConfiguration(JobConfiguration jobConfiguration)
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
- Parameters:
jobConfiguration- Contains the configuration information of a job, such as the file format used to save data in Amazon S3.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobConfiguration
default DescribeBulkImportJobResponse.Builder jobConfiguration(Consumer<JobConfiguration.Builder> jobConfiguration)
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
This is a convenience method that creates an instance of theJobConfiguration.Builderavoiding the need to create one manually viaJobConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tojobConfiguration(JobConfiguration).- Parameters:
jobConfiguration- a consumer that will call methods onJobConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
jobConfiguration(JobConfiguration)
-
jobCreationDate
DescribeBulkImportJobResponse.Builder jobCreationDate(Instant jobCreationDate)
The date the job was created, in Unix epoch TIME.
- Parameters:
jobCreationDate- The date the job was created, in Unix epoch TIME.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobLastUpdateDate
DescribeBulkImportJobResponse.Builder jobLastUpdateDate(Instant jobLastUpdateDate)
The date the job was last updated, in Unix epoch time.
- Parameters:
jobLastUpdateDate- The date the job was last updated, in Unix epoch time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
adaptiveIngestion
DescribeBulkImportJobResponse.Builder adaptiveIngestion(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
deleteFilesAfterImport
DescribeBulkImportJobResponse.Builder deleteFilesAfterImport(Boolean deleteFilesAfterImport)
If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
- Parameters:
deleteFilesAfterImport- If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-