com.tencentcloudapi.cvm.v20170312.models.AssociateInstancesKeyPairsRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-intl-en Show documentation
Tencent Cloud API SDK for Java
There is a newer version: 3.0.1034
Show newest version
/*
 * 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.cvm.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 AssociateInstancesKeyPairsRequest extends AbstractModel{

    /**
    * Instance ID(s). The maximum number of instances in each request is 100. 
You can obtain the available instance IDs in two ways: 
Log in to the [console](https://console.cloud.tencent.com/cvm/index) to query the instance IDs. 
Call [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and look for `InstanceId` in the response.
    */
    @SerializedName("InstanceIds")
    @Expose
    private String [] InstanceIds;

    /**
    * Key ID(s). The maximum number of key pairs in each request is 100. The key pair ID is in the format of `skey-3glfot13`. 
You can obtain the available key pair IDs in two ways: 
Log in to the [console](https://console.cloud.tencent.com/cvm/sshkey) to query the key pair IDs. 
Call [DescribeKeyPairs](https://intl.cloud.tencent.com/document/api/213/15699?from_cn_redirect=1) and look for `KeyId` in the response.
    */
    @SerializedName("KeyIds")
    @Expose
    private String [] KeyIds;

    /**
    * Whether to force shut down a running instances. It is recommended to manually shut down a running instance before associating a key pair with it. Valid values: 
TRUE: force shut down an instance after a normal shutdown fails. 
FALSE: do not force shut down an instance after a normal shutdown fails. 

Default value: FALSE.
    */
    @SerializedName("ForceStop")
    @Expose
    private Boolean ForceStop;

    /**
     * Get Instance ID(s). The maximum number of instances in each request is 100. 
You can obtain the available instance IDs in two ways: 
Log in to the [console](https://console.cloud.tencent.com/cvm/index) to query the instance IDs. 
Call [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and look for `InstanceId` in the response. 
     * @return InstanceIds Instance ID(s). The maximum number of instances in each request is 100. 
You can obtain the available instance IDs in two ways: 
Log in to the [console](https://console.cloud.tencent.com/cvm/index) to query the instance IDs. 
Call [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and look for `InstanceId` in the response.
     */
    public String [] getInstanceIds() {
        return this.InstanceIds;
    }

    /**
     * Set Instance ID(s). The maximum number of instances in each request is 100. 
You can obtain the available instance IDs in two ways: 
Log in to the [console](https://console.cloud.tencent.com/cvm/index) to query the instance IDs. 
Call [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and look for `InstanceId` in the response.
     * @param InstanceIds Instance ID(s). The maximum number of instances in each request is 100. 
You can obtain the available instance IDs in two ways: 
Log in to the [console](https://console.cloud.tencent.com/cvm/index) to query the instance IDs. 
Call [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and look for `InstanceId` in the response.
     */
    public void setInstanceIds(String [] InstanceIds) {
        this.InstanceIds = InstanceIds;
    }

    /**
     * Get Key ID(s). The maximum number of key pairs in each request is 100. The key pair ID is in the format of `skey-3glfot13`. 
You can obtain the available key pair IDs in two ways: 
Log in to the [console](https://console.cloud.tencent.com/cvm/sshkey) to query the key pair IDs. 
Call [DescribeKeyPairs](https://intl.cloud.tencent.com/document/api/213/15699?from_cn_redirect=1) and look for `KeyId` in the response. 
     * @return KeyIds Key ID(s). The maximum number of key pairs in each request is 100. The key pair ID is in the format of `skey-3glfot13`. 
You can obtain the available key pair IDs in two ways: 
Log in to the [console](https://console.cloud.tencent.com/cvm/sshkey) to query the key pair IDs. 
Call [DescribeKeyPairs](https://intl.cloud.tencent.com/document/api/213/15699?from_cn_redirect=1) and look for `KeyId` in the response.
     */
    public String [] getKeyIds() {
        return this.KeyIds;
    }

    /**
     * Set Key ID(s). The maximum number of key pairs in each request is 100. The key pair ID is in the format of `skey-3glfot13`. 
You can obtain the available key pair IDs in two ways: 
Log in to the [console](https://console.cloud.tencent.com/cvm/sshkey) to query the key pair IDs. 
Call [DescribeKeyPairs](https://intl.cloud.tencent.com/document/api/213/15699?from_cn_redirect=1) and look for `KeyId` in the response.
     * @param KeyIds Key ID(s). The maximum number of key pairs in each request is 100. The key pair ID is in the format of `skey-3glfot13`. 
You can obtain the available key pair IDs in two ways: 
Log in to the [console](https://console.cloud.tencent.com/cvm/sshkey) to query the key pair IDs. 
Call [DescribeKeyPairs](https://intl.cloud.tencent.com/document/api/213/15699?from_cn_redirect=1) and look for `KeyId` in the response.
     */
    public void setKeyIds(String [] KeyIds) {
        this.KeyIds = KeyIds;
    }

    /**
     * Get Whether to force shut down a running instances. It is recommended to manually shut down a running instance before associating a key pair with it. Valid values: 
TRUE: force shut down an instance after a normal shutdown fails. 
FALSE: do not force shut down an instance after a normal shutdown fails. 

Default value: FALSE. 
     * @return ForceStop Whether to force shut down a running instances. It is recommended to manually shut down a running instance before associating a key pair with it. Valid values: 
TRUE: force shut down an instance after a normal shutdown fails. 
FALSE: do not force shut down an instance after a normal shutdown fails. 

Default value: FALSE.
     */
    public Boolean getForceStop() {
        return this.ForceStop;
    }

    /**
     * Set Whether to force shut down a running instances. It is recommended to manually shut down a running instance before associating a key pair with it. Valid values: 
TRUE: force shut down an instance after a normal shutdown fails. 
FALSE: do not force shut down an instance after a normal shutdown fails. 

Default value: FALSE.
     * @param ForceStop Whether to force shut down a running instances. It is recommended to manually shut down a running instance before associating a key pair with it. Valid values: 
TRUE: force shut down an instance after a normal shutdown fails. 
FALSE: do not force shut down an instance after a normal shutdown fails. 

Default value: FALSE.
     */
    public void setForceStop(Boolean ForceStop) {
        this.ForceStop = ForceStop;
    }

    public AssociateInstancesKeyPairsRequest() {
    }

    /**
     * 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 AssociateInstancesKeyPairsRequest(AssociateInstancesKeyPairsRequest source) {
        if (source.InstanceIds != null) {
            this.InstanceIds = new String[source.InstanceIds.length];
            for (int i = 0; i < source.InstanceIds.length; i++) {
                this.InstanceIds[i] = new String(source.InstanceIds[i]);
            }
        }
        if (source.KeyIds != null) {
            this.KeyIds = new String[source.KeyIds.length];
            for (int i = 0; i < source.KeyIds.length; i++) {
                this.KeyIds[i] = new String(source.KeyIds[i]);
            }
        }
        if (source.ForceStop != null) {
            this.ForceStop = new Boolean(source.ForceStop);
        }
    }


    /**
     * Internal implementation, normal users should not use it.
     */
    public void toMap(HashMap map, String prefix) {
        this.setParamArraySimple(map, prefix + "InstanceIds.", this.InstanceIds);
        this.setParamArraySimple(map, prefix + "KeyIds.", this.KeyIds);
        this.setParamSimple(map, prefix + "ForceStop", this.ForceStop);

    }
}