Class ListDataSourceSyncJobsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.kendra.model.KendraRequest
software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListDataSourceSyncJobsRequest.Builder,ListDataSourceSyncJobsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListDataSourceSyncJobsRequest extends KendraRequest implements ToCopyableBuilder<ListDataSourceSyncJobsRequest.Builder,ListDataSourceSyncJobsRequest>

  • Method Details

    • id

      public final String id()

      The identifier of the data source connector.

      Returns:
      The identifier of the data source connector.

    • indexId

      public final String indexId()

      The identifier of the index used with the data source connector.

      Returns:
      The identifier of the index used with the data source connector.

    • nextToken

      public final String nextToken()

      If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

      Returns:
      If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

    • maxResults

      public final Integer maxResults()

      The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

      Returns:
      The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

    • startTimeFilter

      public final TimeRange startTimeFilter()

      When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

      Returns:
      When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

    • statusFilter

      public final DataSourceSyncJobStatus statusFilter()

      Only returns synchronization jobs with the Status field equal to the specified status.

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

      Returns:
      Only returns synchronization jobs with the Status field equal to the specified status.
      See Also:

    • statusFilterAsString

      public final String statusFilterAsString()

      Only returns synchronization jobs with the Status field equal to the specified status.

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

      Returns:
      Only returns synchronization jobs with the Status field equal to the specified status.
      See Also:

    • toBuilder

      public ListDataSourceSyncJobsRequest.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<ListDataSourceSyncJobsRequest.Builder,ListDataSourceSyncJobsRequest>
      Specified by:
      toBuilder in class KendraRequest
      Returns:
      a builder for type T

    • builder

      public static ListDataSourceSyncJobsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListDataSourceSyncJobsRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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