content: // 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.cloudstack.acl.RoleType;
  import org.apache.cloudstack.api.APICommand;
  import org.apache.cloudstack.api.ApiCommandResourceType;
  import org.apache.cloudstack.api.ApiConstants;
  import org.apache.cloudstack.api.ApiErrorCode;
  import org.apache.cloudstack.api.BaseAsyncCreateCmd;
  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.AutoScaleVmGroupResponse;
  import org.apache.cloudstack.api.response.AutoScaleVmProfileResponse;
  import org.apache.cloudstack.api.response.FirewallRuleResponse;
  
  import com.cloud.event.EventTypes;
  import com.cloud.exception.InvalidParameterValueException;
  import com.cloud.exception.ResourceAllocationException;
  import com.cloud.network.as.AutoScaleVmGroup;
  import com.cloud.network.rules.LoadBalancer;
  
  @APICommand(name = "createAutoScaleVmGroup",
              description = "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.",
          responseObject = AutoScaleVmGroupResponse.class, entityType = {AutoScaleVmGroup.class},
              requestHasSensitiveInfo = false,
              responseHasSensitiveInfo = false)
  public class CreateAutoScaleVmGroupCmd extends BaseAsyncCreateCmd {
  
      private static final String s_name = "autoscalevmgroupresponse";
  
      // ///////////////////////////////////////////////////
      // ////////////// API parameters /////////////////////
      // ///////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.LBID,
                 type = CommandType.UUID,
                 entityType = FirewallRuleResponse.class,
                 required = true,
                 description = "the ID of the load balancer rule")
      private long lbRuleId;
  
      @Parameter(name = ApiConstants.NAME,
              type = CommandType.STRING,
              description = "the name of the autoscale vmgroup",
              since = "4.18.0")
      private String name;
  
      @Parameter(name = ApiConstants.MIN_MEMBERS,
                 type = CommandType.INTEGER,
                 required = true,
                 description = "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.")
      private int minMembers;
  
      @Parameter(name = ApiConstants.MAX_MEMBERS,
                 type = CommandType.INTEGER,
                 required = true,
                 description = "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.")
      private int maxMembers;
  
      @Parameter(name = ApiConstants.INTERVAL, type = CommandType.INTEGER, description = "the frequency in which the performance counters to be collected")
      private Integer interval;
  
      @Parameter(name = ApiConstants.SCALEUP_POLICY_IDS,
                 type = CommandType.LIST,
                 collectionType = CommandType.UUID,
                 entityType = AutoScalePolicyResponse.class,
                 required = true,
                 description = "list of scaleup autoscale policies")
      private List<Long> scaleUpPolicyIds;
  
      @Parameter(name = ApiConstants.SCALEDOWN_POLICY_IDS,
                 type = CommandType.LIST,
                 collectionType = CommandType.UUID,
                 entityType = AutoScalePolicyResponse.class,
                 required = true,
                 description = "list of scaledown autoscale policies")
      private List<Long> scaleDownPolicyIds;
  
      @Parameter(name = ApiConstants.VMPROFILE_ID,
                 type = CommandType.UUID,
                 entityType = AutoScaleVmProfileResponse.class,
                 required = true,
                 description = "the autoscale profile that contains information about the vms in the vm group.")
      private long profileId;
  
      @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the group to the end user or not", since = "4.4", authorized = {RoleType.Admin})
      private Boolean display;
  
      // ///////////////////////////////////////////////////
      // ///////////////// Accessors ///////////////////////
      // ///////////////////////////////////////////////////
  
  
      public String getName() {
          return name;
      }
  
      public int getMinMembers() {
          return minMembers;
      }
  
      public int getMaxMembers() {
          return maxMembers;
      }
  
      public Integer getInterval() {
          return interval;
      }
  
      public long getProfileId() {
          return profileId;
      }
  
      public List<Long> getScaleUpPolicyIds() {
          return scaleUpPolicyIds;
      }
  
      public List<Long> getScaleDownPolicyIds() {
          return scaleDownPolicyIds;
      }
  
      public long getLbRuleId() {
          return lbRuleId;
      }
  
      // ///////////////////////////////////////////////////
      // ///////////// API Implementation///////////////////
      // ///////////////////////////////////////////////////
  
      @Override
      public String getCommandName() {
          return s_name;
      }
  
      public static String getResultObjectName() {
          return "autoscalevmgroup";
      }
  
      @Override
      public long getEntityOwnerId() {
          LoadBalancer lb = _entityMgr.findById(LoadBalancer.class, getLbRuleId());
          if (lb == null) {
              throw new InvalidParameterValueException("Unable to find loadbalancer by lbRuleId");
          }
          return lb.getAccountId();
      }
  
      public void setLbRuleId(Long lbRuleId) {
          this.lbRuleId = lbRuleId;
      }
  
      @Override
      public String getEventType() {
          return EventTypes.EVENT_AUTOSCALEVMGROUP_CREATE;
      }
  
      @Override
      public String getCreateEventType() {
          return EventTypes.EVENT_AUTOSCALEVMGROUP_CREATE;
      }
  
      @Override
      public String getCreateEventDescription() {
          return "creating AutoScale Vm Group";
      }
  
      @Override
      public String getEventDescription() {
          return "configuring AutoScale Vm Group. Vm Group Id: " + getEntityId();
      }
  
      @Override
      public ApiCommandResourceType getApiResourceType() {
          return ApiCommandResourceType.AutoScaleVmGroup;
      }
  
      @Deprecated
      public Boolean getDisplay() {
          return display;
      }
  
      @Override
      public boolean isDisplay() {
          if(display == null)
              return true;
          else
              return display;
      }
  
      @Override
      public void create() throws ResourceAllocationException {
          AutoScaleVmGroup result = _autoScaleService.createAutoScaleVmGroup(this);
          if (result != null) {
              setEntityId(result.getId());
              setEntityUuid(result.getUuid());
          } else {
              throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Autoscale Vm Group");
          }
      }
  
      @Override
      public void execute() {
          boolean success = false;
          AutoScaleVmGroup vmGroup = null;
          try {
              success = _autoScaleService.configureAutoScaleVmGroup(this);
              if (success) {
                  vmGroup = _entityMgr.findById(AutoScaleVmGroup.class, getEntityId());
                  AutoScaleVmGroupResponse responseObject = _responseGenerator.createAutoScaleVmGroupResponse(vmGroup);
                  setResponseObject(responseObject);
                  responseObject.setResponseName(getCommandName());
              }
          } catch (Exception ex) {
              // TODO what will happen if Resource Layer fails in a step in between
              logger.warn("Failed to create autoscale vm group", ex);
          } finally {
              if (!success || vmGroup == null) {
                  _autoScaleService.deleteAutoScaleVmGroup(getEntityId(), true);
                  throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Autoscale Vm Group");
              }
          }
      }
  }
  