com.tencentcloudapi.vpc.v20170312.models.DescribeNetworkInterfacesRequest Maven / Gradle / Ivy

Go to download
/*
 * 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.vpc.v20170312.models;

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

public class DescribeNetworkInterfacesRequest extends AbstractModel{

    /**
    * Queries the ID of the ENI instance, such as `eni-pxir56ns`. Each request can have a maximum of 100 instances. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
    */
    @SerializedName("NetworkInterfaceIds")
    @Expose
    private String [] NetworkInterfaceIds;

    /**
    * Filter. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
`vpc-id` - String - VPC instance ID, such as `vpc-f49l6u0z`.
`subnet-id` - String - Subnet instance ID, such as `subnet-f49l6u0z`.
`network-interface-id` - String - ENI instance ID, such as `eni-5k56k7k7`.
`attachment.instance-id` - String - ID of the bound CVM instance, such as `ins-3nqpdn3i`.
`groups.security-group-id` - String - ID of the bound security group, such as `sg-f9ekbxeq`.
`network-interface-name` - String - ENI instance name.
`network-interface-description` - String - ENI instance description.
`address-ip` - String - Private IPv4 address. A single IP will be fuzzily matched with the suffix, while multiple IPs will be exactly matched. It can be used with `ip-exact-match` to query and exactly match a single IP.
`ip-exact-match` - Boolean - Exact match by private IPv4 address. The first value will be returned if multiple values are found.
`tag-key` - String - Optional - Filter by tag key. See Example 2 for the detailed usage.
`tag:tag-key` - String - Optional - Filter by tag key pair. Use a specific tag key to replace `tag-key`. See Example 3 for the detailed usage.
`is-primary` - Boolean - Optional - Filter based on whether it is a primary ENI. If the value is `true`, filter only the primary ENI. If the value is `false`, filter only the secondary ENI. If this parameter is not specified, filter the both.
`eni-type` - String - Optional - Filter by ENI type. "0" - secondary ENI, "1" - primary ENI, "2": relayed ENI
    */
    @SerializedName("Filters")
    @Expose
    private Filter [] Filters;

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

    /**
    * Number of returned results. Default value: 20. Maximum value: 100.
    */
    @SerializedName("Limit")
    @Expose
    private Long Limit;

    /**
     * Get Queries the ID of the ENI instance, such as `eni-pxir56ns`. Each request can have a maximum of 100 instances. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time. 
     * @return NetworkInterfaceIds Queries the ID of the ENI instance, such as `eni-pxir56ns`. Each request can have a maximum of 100 instances. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
     */
    public String [] getNetworkInterfaceIds() {
        return this.NetworkInterfaceIds;
    }

    /**
     * Set Queries the ID of the ENI instance, such as `eni-pxir56ns`. Each request can have a maximum of 100 instances. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
     * @param NetworkInterfaceIds Queries the ID of the ENI instance, such as `eni-pxir56ns`. Each request can have a maximum of 100 instances. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
     */
    public void setNetworkInterfaceIds(String [] NetworkInterfaceIds) {
        this.NetworkInterfaceIds = NetworkInterfaceIds;
    }

    /**
     * Get Filter. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
`vpc-id` - String - VPC instance ID, such as `vpc-f49l6u0z`.
`subnet-id` - String - Subnet instance ID, such as `subnet-f49l6u0z`.
`network-interface-id` - String - ENI instance ID, such as `eni-5k56k7k7`.
`attachment.instance-id` - String - ID of the bound CVM instance, such as `ins-3nqpdn3i`.
`groups.security-group-id` - String - ID of the bound security group, such as `sg-f9ekbxeq`.
`network-interface-name` - String - ENI instance name.
`network-interface-description` - String - ENI instance description.
`address-ip` - String - Private IPv4 address. A single IP will be fuzzily matched with the suffix, while multiple IPs will be exactly matched. It can be used with `ip-exact-match` to query and exactly match a single IP.
`ip-exact-match` - Boolean - Exact match by private IPv4 address. The first value will be returned if multiple values are found.
`tag-key` - String - Optional - Filter by tag key. See Example 2 for the detailed usage.
`tag:tag-key` - String - Optional - Filter by tag key pair. Use a specific tag key to replace `tag-key`. See Example 3 for the detailed usage.
`is-primary` - Boolean - Optional - Filter based on whether it is a primary ENI. If the value is `true`, filter only the primary ENI. If the value is `false`, filter only the secondary ENI. If this parameter is not specified, filter the both.
`eni-type` - String - Optional - Filter by ENI type. "0" - secondary ENI, "1" - primary ENI, "2": relayed ENI 
     * @return Filters Filter. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
`vpc-id` - String - VPC instance ID, such as `vpc-f49l6u0z`.
`subnet-id` - String - Subnet instance ID, such as `subnet-f49l6u0z`.
`network-interface-id` - String - ENI instance ID, such as `eni-5k56k7k7`.
`attachment.instance-id` - String - ID of the bound CVM instance, such as `ins-3nqpdn3i`.
`groups.security-group-id` - String - ID of the bound security group, such as `sg-f9ekbxeq`.
`network-interface-name` - String - ENI instance name.
`network-interface-description` - String - ENI instance description.
`address-ip` - String - Private IPv4 address. A single IP will be fuzzily matched with the suffix, while multiple IPs will be exactly matched. It can be used with `ip-exact-match` to query and exactly match a single IP.
`ip-exact-match` - Boolean - Exact match by private IPv4 address. The first value will be returned if multiple values are found.
`tag-key` - String - Optional - Filter by tag key. See Example 2 for the detailed usage.
`tag:tag-key` - String - Optional - Filter by tag key pair. Use a specific tag key to replace `tag-key`. See Example 3 for the detailed usage.
`is-primary` - Boolean - Optional - Filter based on whether it is a primary ENI. If the value is `true`, filter only the primary ENI. If the value is `false`, filter only the secondary ENI. If this parameter is not specified, filter the both.
`eni-type` - String - Optional - Filter by ENI type. "0" - secondary ENI, "1" - primary ENI, "2": relayed ENI
     */
    public Filter [] getFilters() {
        return this.Filters;
    }

    /**
     * Set Filter. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
`vpc-id` - String - VPC instance ID, such as `vpc-f49l6u0z`.
`subnet-id` - String - Subnet instance ID, such as `subnet-f49l6u0z`.
`network-interface-id` - String - ENI instance ID, such as `eni-5k56k7k7`.
`attachment.instance-id` - String - ID of the bound CVM instance, such as `ins-3nqpdn3i`.
`groups.security-group-id` - String - ID of the bound security group, such as `sg-f9ekbxeq`.
`network-interface-name` - String - ENI instance name.
`network-interface-description` - String - ENI instance description.
`address-ip` - String - Private IPv4 address. A single IP will be fuzzily matched with the suffix, while multiple IPs will be exactly matched. It can be used with `ip-exact-match` to query and exactly match a single IP.
`ip-exact-match` - Boolean - Exact match by private IPv4 address. The first value will be returned if multiple values are found.
`tag-key` - String - Optional - Filter by tag key. See Example 2 for the detailed usage.
`tag:tag-key` - String - Optional - Filter by tag key pair. Use a specific tag key to replace `tag-key`. See Example 3 for the detailed usage.
`is-primary` - Boolean - Optional - Filter based on whether it is a primary ENI. If the value is `true`, filter only the primary ENI. If the value is `false`, filter only the secondary ENI. If this parameter is not specified, filter the both.
`eni-type` - String - Optional - Filter by ENI type. "0" - secondary ENI, "1" - primary ENI, "2": relayed ENI
     * @param Filters Filter. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
`vpc-id` - String - VPC instance ID, such as `vpc-f49l6u0z`.
`subnet-id` - String - Subnet instance ID, such as `subnet-f49l6u0z`.
`network-interface-id` - String - ENI instance ID, such as `eni-5k56k7k7`.
`attachment.instance-id` - String - ID of the bound CVM instance, such as `ins-3nqpdn3i`.
`groups.security-group-id` - String - ID of the bound security group, such as `sg-f9ekbxeq`.
`network-interface-name` - String - ENI instance name.
`network-interface-description` - String - ENI instance description.
`address-ip` - String - Private IPv4 address. A single IP will be fuzzily matched with the suffix, while multiple IPs will be exactly matched. It can be used with `ip-exact-match` to query and exactly match a single IP.
`ip-exact-match` - Boolean - Exact match by private IPv4 address. The first value will be returned if multiple values are found.
`tag-key` - String - Optional - Filter by tag key. See Example 2 for the detailed usage.
`tag:tag-key` - String - Optional - Filter by tag key pair. Use a specific tag key to replace `tag-key`. See Example 3 for the detailed usage.
`is-primary` - Boolean - Optional - Filter based on whether it is a primary ENI. If the value is `true`, filter only the primary ENI. If the value is `false`, filter only the secondary ENI. If this parameter is not specified, filter the both.
`eni-type` - String - Optional - Filter by ENI type. "0" - secondary ENI, "1" - primary ENI, "2": relayed ENI
     */
    public void setFilters(Filter [] Filters) {
        this.Filters = Filters;
    }

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

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

    /**
     * Get Number of returned results. Default value: 20. Maximum value: 100. 
     * @return Limit Number of returned results. Default value: 20. Maximum value: 100.
     */
    public Long getLimit() {
        return this.Limit;
    }

    /**
     * Set Number of returned results. Default value: 20. Maximum value: 100.
     * @param Limit Number of returned results. Default value: 20. Maximum value: 100.
     */
    public void setLimit(Long Limit) {
        this.Limit = Limit;
    }

    public DescribeNetworkInterfacesRequest() {
    }

    /**
     * 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 DescribeNetworkInterfacesRequest(DescribeNetworkInterfacesRequest source) {
        if (source.NetworkInterfaceIds != null) {
            this.NetworkInterfaceIds = new String[source.NetworkInterfaceIds.length];
            for (int i = 0; i < source.NetworkInterfaceIds.length; i++) {
                this.NetworkInterfaceIds[i] = new String(source.NetworkInterfaceIds[i]);
            }
        }
        if (source.Filters != null) {
            this.Filters = new Filter[source.Filters.length];
            for (int i = 0; i < source.Filters.length; i++) {
                this.Filters[i] = new Filter(source.Filters[i]);
            }
        }
        if (source.Offset != null) {
            this.Offset = new Long(source.Offset);
        }
        if (source.Limit != null) {
            this.Limit = new Long(source.Limit);
        }
    }


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

    }
}