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.zone;
  
  import java.util.List;
  import java.util.Map;
  
  import org.apache.cloudstack.api.APICommand;
  import org.apache.cloudstack.api.ApiConstants;
  import org.apache.cloudstack.api.BaseListCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.ResponseObject.ResponseView;
  import org.apache.cloudstack.api.TaggedResources;
  import org.apache.cloudstack.api.command.user.UserCmd;
  import org.apache.cloudstack.api.response.DomainResponse;
  import org.apache.cloudstack.api.response.ListResponse;
  import org.apache.cloudstack.api.response.ZoneResponse;
  
  @APICommand(name = "listZones", description = "Lists zones", responseObject = ZoneResponse.class, responseView = ResponseView.Restricted,
          requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
  public class ListZonesCmd extends BaseListCmd implements UserCmd {
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
      @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the ID of the zone")
      private Long id;
  
      @Parameter(name = ApiConstants.IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = ZoneResponse.class, description = "the IDs of the zones, mutually exclusive with id", since = "4.19.0")
      private List<Long> ids;
  
      @Parameter(name = ApiConstants.AVAILABLE,
                 type = CommandType.BOOLEAN,
                 description = "true if you want to retrieve all available Zones. False if you only want to return the Zones"
                     + " from which you have at least one VM. Default is false.")
      private Boolean available;
  
      @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "the ID of the domain associated with the zone")
      private Long domainId;
  
      @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the zone")
      private String name;
  
      @Parameter(name = ApiConstants.NETWORK_TYPE, type = CommandType.STRING, description = "the network type of the zone that the virtual machine belongs to")
      private String networkType;
  
      @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "flag to display the capacity of the zones")
      private Boolean showCapacities;
  
      @Parameter(name = ApiConstants.TAGS, type = CommandType.MAP, description = "List zones by resource tags (key/value pairs)", since = "4.3")
      private Map tags;
  
      @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN, description = "flag to display the resource image for the zones")
      private Boolean showIcon;
  
      @Parameter(name = ApiConstants.STORAGE_ACCESS_GROUP, type = CommandType.STRING,
              description = "the name of the storage access group",
              since = "4.21.0")
      private String storageAccessGroup;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public Long getId() {
          return id;
      }
  
      public List<Long> getIds() {
          return ids;
      }
  
      public Boolean isAvailable() {
          return available;
      }
  
      public Long getDomainId() {
          return domainId;
      }
  
      public String getName() {
          return name;
      }
  
      public String getNetworkType() {
          return networkType;
      }
  
      public Boolean getShowCapacities() {
          return showCapacities;
      }
  
      public Map<String, String> getTags() {
          return TaggedResources.parseKeyValueMap(tags, false);
      }
  
      public Boolean getShowIcon () {
          return  showIcon != null ? showIcon : false;
      }
  
      public String getStorageAccessGroup() {
          return storageAccessGroup;
      }
  
      public ListZonesCmd() {
  
      }
  
      public ListZonesCmd(String storageAccessGroup) {
          this.storageAccessGroup = storageAccessGroup;
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public void execute() {
          ListResponse<ZoneResponse> response = _queryService.listDataCenters(this);
          response.setResponseName(getCommandName());
          setResponseObject(response);
      }
  }
  