com.aliyun.pds20220301.models.SearchFileRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pds20220301 Show documentation
Alibaba Cloud pds (20220301) SDK for Java
The newest version!
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.pds20220301.models;

import com.aliyun.tea.*;

public class SearchFileRequest extends TeaModel {
    /**
     * The drive ID.
     * 
     * example:
     * 1
     */
    @NameInMap("drive_id")
    public String driveId;

    /**
     * example:
     * url,thumbnail
     */
    @NameInMap("fields")
    @Deprecated
    public String fields;

    /**
     * The maximum number of results to return. Valid values: 1 to 100.
     * The number of returned results must be less than or equal to the specified number.
     * 
     * example:
     * 50
     */
    @NameInMap("limit")
    public Integer limit;

    /**
     * The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.\
     * By default, this parameter is left empty.
     * 
     * example:
     * NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
     */
    @NameInMap("marker")
    public String marker;

    /**
     * The field by which to sort the returned results. Default value: created_at. Valid values:
     * 
     * created_at: sorts the results by the time when the file was created.
     * updated_at: sorts the results by the time when the file was modified.
     * size: sorts the results by the size of the file.
     * name: sorts the results by the name of the file.
     * 
     * The order in which you want to sort the returned results. Valid values:
     * 
     * ASC: sorts the results in ascending order.
     * DESC: sorts the results in descending order.
     * 
     * You must specify this parameter in the \ \ format. Separate multiple field names with commas (,). A preceding field has a higher priority than a following field. Examples:
     * 
     * If you want to sort the results based on the file name in ascending order, set this parameter to "name ASC".
     * If you want to sort the results based on the creation time in descending order, set this parameter to "created_at DESC".
     * If you want to sort the results based on the creation time in descending order first, and then sort the results based on the file name in ascending order if the creation time is the same, set this parameter to "created_at DESC,name ASC".
     * 
     * 
     * example:
     * name
     */
    @NameInMap("order_by")
    public String orderBy;

    /**
     * The search condition. Fuzzy searches based on the file name or directory name are supported. The search condition can be up to 4,096 characters in length.
     * This parameter is required.
     * 
     * example:
     * not name=123
     */
    @NameInMap("query")
    public String query;

    @NameInMap("recursive")
    public Boolean recursive;

    /**
     * Specifies whether to return the total number of retrieved files.
     * 
     * example:
     * true
     */
    @NameInMap("return_total_count")
    public Boolean returnTotalCount;

    public static SearchFileRequest build(java.util.Map map) throws Exception {
        SearchFileRequest self = new SearchFileRequest();
        return TeaModel.build(map, self);
    }

    public SearchFileRequest setDriveId(String driveId) {
        this.driveId = driveId;
        return this;
    }
    public String getDriveId() {
        return this.driveId;
    }

    public SearchFileRequest setFields(String fields) {
        this.fields = fields;
        return this;
    }
    public String getFields() {
        return this.fields;
    }

    public SearchFileRequest setLimit(Integer limit) {
        this.limit = limit;
        return this;
    }
    public Integer getLimit() {
        return this.limit;
    }

    public SearchFileRequest setMarker(String marker) {
        this.marker = marker;
        return this;
    }
    public String getMarker() {
        return this.marker;
    }

    public SearchFileRequest setOrderBy(String orderBy) {
        this.orderBy = orderBy;
        return this;
    }
    public String getOrderBy() {
        return this.orderBy;
    }

    public SearchFileRequest setQuery(String query) {
        this.query = query;
        return this;
    }
    public String getQuery() {
        return this.query;
    }

    public SearchFileRequest setRecursive(Boolean recursive) {
        this.recursive = recursive;
        return this;
    }
    public Boolean getRecursive() {
        return this.recursive;
    }

    public SearchFileRequest setReturnTotalCount(Boolean returnTotalCount) {
        this.returnTotalCount = returnTotalCount;
        return this;
    }
    public Boolean getReturnTotalCount() {
        return this.returnTotalCount;
    }

}