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.admin.pod;
  
  import java.util.ArrayList;
  import java.util.List;
  
  
  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.response.ListResponse;
  import org.apache.cloudstack.api.response.PodResponse;
  import org.apache.cloudstack.api.response.ZoneResponse;
  
  import com.cloud.dc.Pod;
  import com.cloud.utils.Pair;
  
  @APICommand(name = "listPods", description = "Lists all Pods.", responseObject = PodResponse.class,
          requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
  public class ListPodsByCmd extends BaseListCmd {
  
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PodResponse.class, description = "list Pods by ID")
      private Long id;
  
      @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list Pods by name")
      private String podName;
  
      @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "list Pods by Zone ID")
      private Long zoneId;
  
      @Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "list pods by allocation state")
      private String allocationState;
  
      @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "flag to display the capacity of the pods")
      private Boolean showCapacities;
  
      @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 String getPodName() {
          return podName;
      }
  
      public Long getZoneId() {
          return zoneId;
      }
  
      public String getAllocationState() {
          return allocationState;
      }
  
      public Boolean getShowCapacities() {
          return showCapacities;
      }
  
      public String getStorageAccessGroup() {
          return storageAccessGroup;
      }
  
      public ListPodsByCmd() {
  
      }
  
      public ListPodsByCmd(String storageAccessGroup) {
          this.storageAccessGroup = storageAccessGroup;
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public void execute() {
          Pair<List<? extends Pod>, Integer> result = _mgr.searchForPods(this);
          ListResponse<PodResponse> response = new ListResponse<>();
          List<PodResponse> podResponses = new ArrayList<>();
          for (Pod pod : result.first()) {
              PodResponse podResponse = _responseGenerator.createPodResponse(pod, showCapacities);
              podResponse.setObjectName("pod");
              podResponses.add(podResponse);
          }
  
          response.setResponses(podResponses, result.second());
          response.setResponseName(getCommandName());
          this.setResponseObject(response);
      }
  }
  