JobSummary (AWS Java SDK :: Services :: Io T Site Wise 2.17.292 API)

java.lang.Object
- software.amazon.awssdk.services.iotsitewise.model.JobSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<JobSummary.Builder,JobSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class JobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobSummary.Builder,JobSummary>

Contains a job summary information.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JobSummary.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()` The ID of the job.
`String`	`name()` The unique name that helps identify the job request.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends JobSummary.Builder>`	`serializableBuilderClass()`
`JobStatus`	`status()` The status of the bulk import job can be one of following values.
`String`	`statusAsString()` The status of the bulk import job can be one of following values.
`JobSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - id
```
public final String id()
```
    The ID of the job.
    
    Returns:
    
    The ID of the job.
  - name
```
public final String name()
```
    The unique name that helps identify the job request.
    
    Returns:
    
    The unique name that helps identify the job request.
  - status
```
public final JobStatus status()
```
    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, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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
  - statusAsString
```
public final String statusAsString()
```
    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, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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
  - toBuilder
```
public JobSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JobSummary.Builder,JobSummary>
  - builder
```
public static JobSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JobSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class JobSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

name

status

statusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields