• Home
• com.tencentcloudapi
• tencentcloud-sdk-java-intl-en
• 3.0.582
• source code
• DescribePurgeTasksRequest.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.tencentcloudapi.teo.v20220901.models.DescribePurgeTasksRequest Maven / Gradle / Ivy

/*
 * Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. 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.
 * 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 com.tencentcloudapi.teo.v20220901.models;

import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;

public class DescribePurgeTasksRequest extends AbstractModel{

    /**
    * Disused. Use "zone-id" in "Filters" instead.
    */
    @SerializedName("ZoneId")
    @Expose
    private String ZoneId;

    /**
    * Start time of the query.
    */
    @SerializedName("StartTime")
    @Expose
    private String StartTime;

    /**
    * End time of the query.
    */
    @SerializedName("EndTime")
    @Expose
    private String EndTime;

    /**
    * Offset for paginated queries. Default value: `0`.
    */
    @SerializedName("Offset")
    @Expose
    private Long Offset;

    /**
    * Limit on paginated queries. Default value: `20`. Maximum value: `1000`.
    */
    @SerializedName("Limit")
    @Expose
    private Long Limit;

    /**
    * Filter criteria. Each filter criteria can have up to 20 entries. 
`zone-id`:
   Filter by site ID, such as zone-xxx (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
`job-id`:
   Filter by task ID, such as 1379afjk91u32h (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
`target`:
   Filter by target resource, such as http://www.qq.com/1.txt and tag1
   Type: String
   Required: No
   Fuzzy query: Not supported
`domains`:
   Filter by domain name, such as www.qq.com
   Type: String
   Required: No
   Fuzzy query: Not supported
`statuses`:
   Filter by task status
   Required: No
   Fuzzy query: Not supported
   Values:
   `processing`: The task is in progress.
   `success`: The task succeeded.
   `failed`: The task failed.
   `timeout`: The task timed out.
`type`:
   Filter by purging mode (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
   Values:
   `purge_url`: Purge by URL.
   `purge_prefix`: Purge by prefix.
   `purge_all`: Purge all caches.
   `purge_host`: Purge by hostname.
   `purge_cache_tag`: Purge by cache tag.
    */
    @SerializedName("Filters")
    @Expose
    private AdvancedFilter [] Filters;

    /**
     * Get Disused. Use "zone-id" in "Filters" instead. 
     * @return ZoneId Disused. Use "zone-id" in "Filters" instead.
     */
    public String getZoneId() {
        return this.ZoneId;
    }

    /**
     * Set Disused. Use "zone-id" in "Filters" instead.
     * @param ZoneId Disused. Use "zone-id" in "Filters" instead.
     */
    public void setZoneId(String ZoneId) {
        this.ZoneId = ZoneId;
    }

    /**
     * Get Start time of the query. 
     * @return StartTime Start time of the query.
     */
    public String getStartTime() {
        return this.StartTime;
    }

    /**
     * Set Start time of the query.
     * @param StartTime Start time of the query.
     */
    public void setStartTime(String StartTime) {
        this.StartTime = StartTime;
    }

    /**
     * Get End time of the query. 
     * @return EndTime End time of the query.
     */
    public String getEndTime() {
        return this.EndTime;
    }

    /**
     * Set End time of the query.
     * @param EndTime End time of the query.
     */
    public void setEndTime(String EndTime) {
        this.EndTime = EndTime;
    }

    /**
     * Get Offset for paginated queries. Default value: `0`. 
     * @return Offset Offset for paginated queries. Default value: `0`.
     */
    public Long getOffset() {
        return this.Offset;
    }

    /**
     * Set Offset for paginated queries. Default value: `0`.
     * @param Offset Offset for paginated queries. Default value: `0`.
     */
    public void setOffset(Long Offset) {
        this.Offset = Offset;
    }

    /**
     * Get Limit on paginated queries. Default value: `20`. Maximum value: `1000`. 
     * @return Limit Limit on paginated queries. Default value: `20`. Maximum value: `1000`.
     */
    public Long getLimit() {
        return this.Limit;
    }

    /**
     * Set Limit on paginated queries. Default value: `20`. Maximum value: `1000`.
     * @param Limit Limit on paginated queries. Default value: `20`. Maximum value: `1000`.
     */
    public void setLimit(Long Limit) {
        this.Limit = Limit;
    }

    /**
     * Get Filter criteria. Each filter criteria can have up to 20 entries. 
`zone-id`:
   Filter by site ID, such as zone-xxx (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
`job-id`:
   Filter by task ID, such as 1379afjk91u32h (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
`target`:
   Filter by target resource, such as http://www.qq.com/1.txt and tag1
   Type: String
   Required: No
   Fuzzy query: Not supported
`domains`:
   Filter by domain name, such as www.qq.com
   Type: String
   Required: No
   Fuzzy query: Not supported
`statuses`:
   Filter by task status
   Required: No
   Fuzzy query: Not supported
   Values:
   `processing`: The task is in progress.
   `success`: The task succeeded.
   `failed`: The task failed.
   `timeout`: The task timed out.
`type`:
   Filter by purging mode (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
   Values:
   `purge_url`: Purge by URL.
   `purge_prefix`: Purge by prefix.
   `purge_all`: Purge all caches.
   `purge_host`: Purge by hostname.
   `purge_cache_tag`: Purge by cache tag.
 
     * @return Filters Filter criteria. Each filter criteria can have up to 20 entries. 
`zone-id`:
   Filter by site ID, such as zone-xxx (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
`job-id`:
   Filter by task ID, such as 1379afjk91u32h (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
`target`:
   Filter by target resource, such as http://www.qq.com/1.txt and tag1
   Type: String
   Required: No
   Fuzzy query: Not supported
`domains`:
   Filter by domain name, such as www.qq.com
   Type: String
   Required: No
   Fuzzy query: Not supported
`statuses`:
   Filter by task status
   Required: No
   Fuzzy query: Not supported
   Values:
   `processing`: The task is in progress.
   `success`: The task succeeded.
   `failed`: The task failed.
   `timeout`: The task timed out.
`type`:
   Filter by purging mode (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
   Values:
   `purge_url`: Purge by URL.
   `purge_prefix`: Purge by prefix.
   `purge_all`: Purge all caches.
   `purge_host`: Purge by hostname.
   `purge_cache_tag`: Purge by cache tag.
     */
    public AdvancedFilter [] getFilters() {
        return this.Filters;
    }

    /**
     * Set Filter criteria. Each filter criteria can have up to 20 entries. 
`zone-id`:
   Filter by site ID, such as zone-xxx (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
`job-id`:
   Filter by task ID, such as 1379afjk91u32h (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
`target`:
   Filter by target resource, such as http://www.qq.com/1.txt and tag1
   Type: String
   Required: No
   Fuzzy query: Not supported
`domains`:
   Filter by domain name, such as www.qq.com
   Type: String
   Required: No
   Fuzzy query: Not supported
`statuses`:
   Filter by task status
   Required: No
   Fuzzy query: Not supported
   Values:
   `processing`: The task is in progress.
   `success`: The task succeeded.
   `failed`: The task failed.
   `timeout`: The task timed out.
`type`:
   Filter by purging mode (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
   Values:
   `purge_url`: Purge by URL.
   `purge_prefix`: Purge by prefix.
   `purge_all`: Purge all caches.
   `purge_host`: Purge by hostname.
   `purge_cache_tag`: Purge by cache tag.
     * @param Filters Filter criteria. Each filter criteria can have up to 20 entries. 
`zone-id`:
   Filter by site ID, such as zone-xxx (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
`job-id`:
   Filter by task ID, such as 1379afjk91u32h (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
`target`:
   Filter by target resource, such as http://www.qq.com/1.txt and tag1
   Type: String
   Required: No
   Fuzzy query: Not supported
`domains`:
   Filter by domain name, such as www.qq.com
   Type: String
   Required: No
   Fuzzy query: Not supported
`statuses`:
   Filter by task status
   Required: No
   Fuzzy query: Not supported
   Values:
   `processing`: The task is in progress.
   `success`: The task succeeded.
   `failed`: The task failed.
   `timeout`: The task timed out.
`type`:
   Filter by purging mode (up to one entry)
   Type: String
   Required: No
   Fuzzy query: Not supported
   Values:
   `purge_url`: Purge by URL.
   `purge_prefix`: Purge by prefix.
   `purge_all`: Purge all caches.
   `purge_host`: Purge by hostname.
   `purge_cache_tag`: Purge by cache tag.
     */
    public void setFilters(AdvancedFilter [] Filters) {
        this.Filters = Filters;
    }

    public DescribePurgeTasksRequest() {
    }

    /**
     * NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
     *       and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
     */
    public DescribePurgeTasksRequest(DescribePurgeTasksRequest source) {
        if (source.ZoneId != null) {
            this.ZoneId = new String(source.ZoneId);
        }
        if (source.StartTime != null) {
            this.StartTime = new String(source.StartTime);
        }
        if (source.EndTime != null) {
            this.EndTime = new String(source.EndTime);
        }
        if (source.Offset != null) {
            this.Offset = new Long(source.Offset);
        }
        if (source.Limit != null) {
            this.Limit = new Long(source.Limit);
        }
        if (source.Filters != null) {
            this.Filters = new AdvancedFilter[source.Filters.length];
            for (int i = 0; i < source.Filters.length; i++) {
                this.Filters[i] = new AdvancedFilter(source.Filters[i]);
            }
        }
    }


    /**
     * Internal implementation, normal users should not use it.
     */
    public void toMap(HashMap map, String prefix) {
        this.setParamSimple(map, prefix + "ZoneId", this.ZoneId);
        this.setParamSimple(map, prefix + "StartTime", this.StartTime);
        this.setParamSimple(map, prefix + "EndTime", this.EndTime);
        this.setParamSimple(map, prefix + "Offset", this.Offset);
        this.setParamSimple(map, prefix + "Limit", this.Limit);
        this.setParamArrayObj(map, prefix + "Filters.", this.Filters);

    }
}