com.amazonaws.services.kendra.model.ListDataSourceSyncJobsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kendra.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListDataSourceSyncJobsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the data source connector.
*
*/
private String id;
/**
*
* The identifier of the index used with the data source connector.
*
*/
private String indexId;
/**
*
* 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.
*
*/
private String nextToken;
/**
*
* 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.
*
*/
private Integer maxResults;
/**
*
* When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
*
*/
private TimeRange startTimeFilter;
/**
*
* Only returns synchronization jobs with the Status field equal to the specified status.
*
*/
private String statusFilter;
/**
*
* The identifier of the data source connector.
*
*
* @param id
* The identifier of the data source connector.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The identifier of the data source connector.
*
*
* @return The identifier of the data source connector.
*/
public String getId() {
return this.id;
}
/**
*
* The identifier of the data source connector.
*
*
* @param id
* The identifier of the data source connector.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDataSourceSyncJobsRequest withId(String id) {
setId(id);
return this;
}
/**
*
* The identifier of the index used with the data source connector.
*
*
* @param indexId
* The identifier of the index used with the data source connector.
*/
public void setIndexId(String indexId) {
this.indexId = indexId;
}
/**
*
* The identifier of the index used with the data source connector.
*
*
* @return The identifier of the index used with the data source connector.
*/
public String getIndexId() {
return this.indexId;
}
/**
*
* The identifier of the index used with the data source connector.
*
*
* @param indexId
* The identifier of the index used with the data source connector.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDataSourceSyncJobsRequest withIndexId(String indexId) {
setIndexId(indexId);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setNextToken(String nextToken) {
this.nextToken = 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.
*
*
* @return 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.
*/
public String getNextToken() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDataSourceSyncJobsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = 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.
*
*
* @return 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.
*/
public Integer getMaxResults() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDataSourceSyncJobsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
*
*
* @param startTimeFilter
* When specified, the synchronization jobs returned in the list are limited to jobs between the specified
* dates.
*/
public void setStartTimeFilter(TimeRange startTimeFilter) {
this.startTimeFilter = startTimeFilter;
}
/**
*
* When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
*
*
* @return When specified, the synchronization jobs returned in the list are limited to jobs between the specified
* dates.
*/
public TimeRange getStartTimeFilter() {
return this.startTimeFilter;
}
/**
*
* When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
*
*
* @param startTimeFilter
* When specified, the synchronization jobs returned in the list are limited to jobs between the specified
* dates.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDataSourceSyncJobsRequest withStartTimeFilter(TimeRange startTimeFilter) {
setStartTimeFilter(startTimeFilter);
return this;
}
/**
*
* Only returns synchronization jobs with the Status field equal to the specified status.
*
*
* @param statusFilter
* Only returns synchronization jobs with the Status field equal to the specified status.
* @see DataSourceSyncJobStatus
*/
public void setStatusFilter(String statusFilter) {
this.statusFilter = statusFilter;
}
/**
*
* Only returns synchronization jobs with the Status field equal to the specified status.
*
*
* @return Only returns synchronization jobs with the Status field equal to the specified status.
* @see DataSourceSyncJobStatus
*/
public String getStatusFilter() {
return this.statusFilter;
}
/**
*
* Only returns synchronization jobs with the Status field equal to the specified status.
*
*
* @param statusFilter
* Only returns synchronization jobs with the Status field equal to the specified status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataSourceSyncJobStatus
*/
public ListDataSourceSyncJobsRequest withStatusFilter(String statusFilter) {
setStatusFilter(statusFilter);
return this;
}
/**
*
* Only returns synchronization jobs with the Status field equal to the specified status.
*
*
* @param statusFilter
* Only returns synchronization jobs with the Status field equal to the specified status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataSourceSyncJobStatus
*/
public ListDataSourceSyncJobsRequest withStatusFilter(DataSourceSyncJobStatus statusFilter) {
this.statusFilter = statusFilter.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getIndexId() != null)
sb.append("IndexId: ").append(getIndexId()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getStartTimeFilter() != null)
sb.append("StartTimeFilter: ").append(getStartTimeFilter()).append(",");
if (getStatusFilter() != null)
sb.append("StatusFilter: ").append(getStatusFilter());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListDataSourceSyncJobsRequest == false)
return false;
ListDataSourceSyncJobsRequest other = (ListDataSourceSyncJobsRequest) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getIndexId() == null ^ this.getIndexId() == null)
return false;
if (other.getIndexId() != null && other.getIndexId().equals(this.getIndexId()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getStartTimeFilter() == null ^ this.getStartTimeFilter() == null)
return false;
if (other.getStartTimeFilter() != null && other.getStartTimeFilter().equals(this.getStartTimeFilter()) == false)
return false;
if (other.getStatusFilter() == null ^ this.getStatusFilter() == null)
return false;
if (other.getStatusFilter() != null && other.getStatusFilter().equals(this.getStatusFilter()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getIndexId() == null) ? 0 : getIndexId().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getStartTimeFilter() == null) ? 0 : getStartTimeFilter().hashCode());
hashCode = prime * hashCode + ((getStatusFilter() == null) ? 0 : getStatusFilter().hashCode());
return hashCode;
}
@Override
public ListDataSourceSyncJobsRequest clone() {
return (ListDataSourceSyncJobsRequest) super.clone();
}
}