Interface DataSourceSyncJob.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>, SdkBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>, SdkPojo
Enclosing class:
DataSourceSyncJob
@Mutable @NotThreadSafe public static interface DataSourceSyncJob.Builder extends SdkPojo, CopyableBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>

  • Method Details

    • executionId

      DataSourceSyncJob.Builder executionId(String executionId)

      A identifier for the synchronization job.

      Parameters:
      executionId - A identifier for the synchronization job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      DataSourceSyncJob.Builder startTime(Instant startTime)

      The Unix timestamp when the synchronization job started.

      Parameters:
      startTime - The Unix timestamp when the synchronization job started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      DataSourceSyncJob.Builder endTime(Instant endTime)

      The Unix timestamp when the synchronization job completed.

      Parameters:
      endTime - The Unix timestamp when the synchronization job completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DataSourceSyncJob.Builder status(String status)

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

      Parameters:
      status - The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DataSourceSyncJob.Builder status(DataSourceSyncJobStatus status)

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

      Parameters:
      status - The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorMessage

      DataSourceSyncJob.Builder errorMessage(String errorMessage)

      If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

      Parameters:
      errorMessage - If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorCode

      DataSourceSyncJob.Builder errorCode(String errorCode)

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

      Parameters:
      errorCode - If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorCode

      DataSourceSyncJob.Builder errorCode(ErrorCode errorCode)

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

      Parameters:
      errorCode - If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataSourceErrorCode

      DataSourceSyncJob.Builder dataSourceErrorCode(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • metrics

      DataSourceSyncJob.Builder metrics(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • metrics

      default DataSourceSyncJob.Builder metrics(Consumer<DataSourceSyncJobMetrics.Builder> 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.

      This is a convenience method that creates an instance of the DataSourceSyncJobMetrics.Builder avoiding the need to create one manually via DataSourceSyncJobMetrics.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metrics(DataSourceSyncJobMetrics).

      Parameters:
      metrics - a consumer that will call methods on DataSourceSyncJobMetrics.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: