/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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 org.apache.nifi.web.api.dto.action;
import com.wordnik.swagger.annotations.ApiModelProperty;
import org.apache.nifi.web.api.dto.util.DateTimeAdapter;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import java.util.Date;
/**
* A history query to find desired actions.
*/
@XmlType(name = "historyQuery")
public class HistoryQueryDTO {
private String userIdentity;
private String sourceId;
private Date startDate;
private Date endDate;
private Integer offset;
private Integer count;
private String sortColumn;
private String sortOrder;
/**
* @return user identity
*/
@ApiModelProperty(
value = "The user identity."
)
public String getUserIdentity() {
return userIdentity;
}
public void setUserIdentity(String userIdentity) {
this.userIdentity = userIdentity;
}
/**
* @return source component id
*/
@ApiModelProperty(
value = "The id of the source component."
)
public String getSourceId() {
return sourceId;
}
public void setSourceId(String sourceId) {
this.sourceId = sourceId;
}
/**
* @return start date
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The start date of actions to return.",
dataType = "string"
)
public Date getStartDate() {
return startDate;
}
public void setStartDate(Date startDate) {
this.startDate = startDate;
}
/**
* @return end date
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The end date of actions to return.",
dataType = "string"
)
public Date getEndDate() {
return endDate;
}
public void setEndDate(Date endDate) {
this.endDate = endDate;
}
/**
* @return offset
*/
@ApiModelProperty(
value = "The offset into the result set."
)
public Integer getOffset() {
return offset;
}
public void setOffset(Integer offset) {
this.offset = offset;
}
/**
* @return desired row count
*/
@ApiModelProperty(
value = "The number of actions to return."
)
public Integer getCount() {
return count;
}
public void setCount(Integer count) {
this.count = count;
}
/**
* @return desired sort column
*/
@ApiModelProperty(
value = "The field to sort on."
)
public String getSortColumn() {
return sortColumn;
}
public void setSortColumn(String sortColumn) {
this.sortColumn = sortColumn;
}
/**
* @return desired sort order
*/
@ApiModelProperty(
value = "The sort order."
)
public String getSortOrder() {
return sortOrder;
}
public void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
}