com.aliyun.pds20220301.models.ListFileRequest Maven / Gradle / Ivy
Show all versions of pds20220301 Show documentation
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.pds20220301.models;
import com.aliyun.tea.*;
public class ListFileRequest extends TeaModel {
/**
* The category of the file. Valid values:
* app: installation package. zip: compressed package. image: image. doc: document. video: video. audio: audio. others: other files.
* By default, files of all categories are returned.
*
* example:
* image
*/
@NameInMap("category")
public String category;
/**
* The drive ID.
*
* example:
* 1
*/
@NameInMap("drive_id")
public String driveId;
/**
* The fields to return.
*
* - If this parameter is set to \*, all fields of the file except the fields that must be specified are returned.
* - If only specific fields are required, you can specify the following fields: url, exif, cropping_suggestion, characteristic_hash, video_metadata, and video_preview_metadata. If multiple fields are required, separate them with commas (,). Example: url,exif.
* - The investigation_info field is returned only if you specify this field.
*
* By default, all fields except the fields that must be specified are returned.
*
* example:
*
*
*
*/
@NameInMap("fields")
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 empty.
*
* example:
* NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
*/
@NameInMap("marker")
public String marker;
/**
* The sorting field.
* Default value: created_at.
* Valid values:
*
* updated_at
*
*
* :
*
*
* sorts the results based on the time when the file was last modified
*
*
* .
* size
*
*
* :
*
*
* sorts the results based on the size of the file
*
*
* .
* name
*
*
* :
*
*
* sorts the results based on the name of the file
*
*
* .
* created_at
*
*
* :
*
*
* sorts the results based on the time when the file was created
*
*
* .
*
*
* example:
* updated_at
*/
@NameInMap("order_by")
public String orderBy;
/**
* The sorting direction. Valid values:
* ASC: ascending order. DESC: descending order.
* Default value: ASC.
*
* example:
* ASC
*/
@NameInMap("order_direction")
public String orderDirection;
/**
* The ID of the parent folder. If the parent folder is a root directory, set this parameter to root.
* This parameter is required.
*
* example:
* root
*/
@NameInMap("parent_file_id")
public String parentFileId;
/**
* The share ID. If you want to manage a file by using a share link, carry the x-share-token header for authentication in the request and specify share_id. In this case, drive_id is invalid. Otherwise, use an AccessKey pair or access token for authentication and specify drive_id. You must specify one of share_id and drive_id.
*
* example:
* 7JQX1FswpQ8
*/
@NameInMap("share_id")
public String shareId;
/**
* The state of the file. Valid values:
* available: Only normal files are returned. uploading: Only files that are being uploaded are returned.
* By default, only files in the available state are returned.
*
* example:
* available
*/
@NameInMap("status")
public String status;
/**
* The thumbnail configurations. Up to five thumbnails can be returned at a time. The value contains key-value pairs. You can customize the keys. The URL of a thumbnail is returned based on the key.
*/
@NameInMap("thumbnail_processes")
public java.util.Map thumbnailProcesses;
/**
* The type of the file. Valid values:
* file: Only files are returned. folder: Only folders are returned.
* By default, files of all types are returned.
*
* example:
* file
*/
@NameInMap("type")
public String type;
public static ListFileRequest build(java.util.Map map) throws Exception {
ListFileRequest self = new ListFileRequest();
return TeaModel.build(map, self);
}
public ListFileRequest setCategory(String category) {
this.category = category;
return this;
}
public String getCategory() {
return this.category;
}
public ListFileRequest setDriveId(String driveId) {
this.driveId = driveId;
return this;
}
public String getDriveId() {
return this.driveId;
}
public ListFileRequest setFields(String fields) {
this.fields = fields;
return this;
}
public String getFields() {
return this.fields;
}
public ListFileRequest setLimit(Integer limit) {
this.limit = limit;
return this;
}
public Integer getLimit() {
return this.limit;
}
public ListFileRequest setMarker(String marker) {
this.marker = marker;
return this;
}
public String getMarker() {
return this.marker;
}
public ListFileRequest setOrderBy(String orderBy) {
this.orderBy = orderBy;
return this;
}
public String getOrderBy() {
return this.orderBy;
}
public ListFileRequest setOrderDirection(String orderDirection) {
this.orderDirection = orderDirection;
return this;
}
public String getOrderDirection() {
return this.orderDirection;
}
public ListFileRequest setParentFileId(String parentFileId) {
this.parentFileId = parentFileId;
return this;
}
public String getParentFileId() {
return this.parentFileId;
}
public ListFileRequest setShareId(String shareId) {
this.shareId = shareId;
return this;
}
public String getShareId() {
return this.shareId;
}
public ListFileRequest setStatus(String status) {
this.status = status;
return this;
}
public String getStatus() {
return this.status;
}
public ListFileRequest setThumbnailProcesses(java.util.Map thumbnailProcesses) {
this.thumbnailProcesses = thumbnailProcesses;
return this;
}
public java.util.Map getThumbnailProcesses() {
return this.thumbnailProcesses;
}
public ListFileRequest setType(String type) {
this.type = type;
return this;
}
public String getType() {
return this.type;
}
}