// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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 org.apache.cloudstack.api.command.user.autoscale;
import java.util.List;
import org.apache.log4j.Logger;
import org.apache.cloudstack.acl.SecurityChecker.AccessType;
import org.apache.cloudstack.api.ACL;
import org.apache.cloudstack.api.APICommand;
import org.apache.cloudstack.api.ApiCommandJobType;
import org.apache.cloudstack.api.ApiConstants;
import org.apache.cloudstack.api.ApiErrorCode;
import org.apache.cloudstack.api.BaseAsyncCmd;
import org.apache.cloudstack.api.Parameter;
import org.apache.cloudstack.api.ServerApiException;
import org.apache.cloudstack.api.response.AutoScalePolicyResponse;
import org.apache.cloudstack.api.response.ConditionResponse;
import org.apache.cloudstack.context.CallContext;
import com.cloud.event.EventTypes;
import com.cloud.network.as.AutoScalePolicy;
import com.cloud.user.Account;
@APICommand(name = "updateAutoScalePolicy", description = "Updates an existing autoscale policy.", responseObject = AutoScalePolicyResponse.class, entityType = {AutoScalePolicy.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateAutoScalePolicyCmd extends BaseAsyncCmd {
public static final Logger s_logger = Logger.getLogger(UpdateAutoScalePolicyCmd.class.getName());
private static final String s_name = "updateautoscalepolicyresponse";
// ///////////////////////////////////////////////////
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
@Parameter(name = ApiConstants.DURATION, type = CommandType.INTEGER, description = "the duration for which the conditions have to be true before action is taken")
private Integer duration;
@Parameter(name = ApiConstants.QUIETTIME,
type = CommandType.INTEGER,
description = "the cool down period for which the policy should not be evaluated after the action has been taken")
private Integer quietTime;
@Parameter(name = ApiConstants.CONDITION_IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = ConditionResponse.class,
description = "the list of IDs of the conditions that are being evaluated on every interval")
private List<Long> conditionIds;
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name = ApiConstants.ID,
type = CommandType.UUID,
entityType = AutoScalePolicyResponse.class,
required = true,
description = "the ID of the autoscale policy")
private Long id;
@Override
public void execute() {
CallContext.current().setEventDetails("AutoScale Policy Id: " + getId());
AutoScalePolicy result = _autoScaleService.updateAutoScalePolicy(this);
if (result != null) {
AutoScalePolicyResponse response = _responseGenerator.createAutoScalePolicyResponse(result);
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update autoscale policy");
}
}
// ///////////////////////////////////////////////////
// ///////////////// Accessors ///////////////////////
// ///////////////////////////////////////////////////
public Long getId() {
return id;
}
public Integer getDuration() {
return duration;
}
public Integer getQuietTime() {
return quietTime;
}
public List<Long> getConditionIds() {
return conditionIds;
}
@Override
public String getCommandName() {
return s_name;
}
@Override
public long getEntityOwnerId() {
AutoScalePolicy autoScalePolicy = _entityMgr.findById(AutoScalePolicy.class, getId());
if (autoScalePolicy != null) {
return autoScalePolicy.getAccountId();
}
return Account.ACCOUNT_ID_SYSTEM; // no account info given, parent this command to SYSTEM so ERROR events are
// tracked
}
@Override
public String getEventType() {
return EventTypes.EVENT_AUTOSCALEPOLICY_UPDATE;
}
@Override
public String getEventDescription() {
return "Updating Auto Scale Policy. Policy Id: " + getId();
}
@Override
public ApiCommandJobType getInstanceType() {
return ApiCommandJobType.AutoScalePolicy;
}
}