Class DataSourceSyncJob

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.DataSourceSyncJob
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>
@Generated("software.amazon.awssdk:codegen") public final class DataSourceSyncJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>

Provides information about an Amazon Q Business data source connector synchronization job.

See Also:

  • Method Details

    • executionId

      public final String executionId()

      The identifier of a data source synchronization job.

      Returns:
      The identifier of a data source synchronization job.

    • startTime

      public final Instant startTime()

      The Unix time stamp when the data source synchronization job started.

      Returns:
      The Unix time stamp when the data source synchronization job started.

    • endTime

      public final Instant endTime()

      The Unix timestamp when the synchronization job completed.

      Returns:
      The Unix timestamp when the synchronization job completed.

    • status

      public final DataSourceSyncJobStatus status()

      The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

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

      Returns:
      The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

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

      Returns:
      The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.
      See Also:

    • error

      public final ErrorDetail error()

      If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

      Returns:
      If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

    • dataSourceErrorCode

      public final String dataSourceErrorCode()

      If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

      Returns:
      If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

    • metrics

      public final DataSourceSyncJobMetrics metrics()

      Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

      Returns:
      Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

    • toBuilder

      public DataSourceSyncJob.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<DataSourceSyncJob.Builder,DataSourceSyncJob>
      Returns:
      a builder for type T

    • builder

      public static DataSourceSyncJob.Builder builder()

    • serializableBuilderClass

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

    • 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.