rahil-c commented on code in PR #11180: URL: https://github.com/apache/iceberg/pull/11180#discussion_r1779211148
########## core/src/main/java/org/apache/iceberg/rest/responses/FetchPlanningResultResponse.java: ########## @@ -0,0 +1,51 @@ +/* + * 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.iceberg.rest.responses; + +import java.util.List; +import javax.annotation.Nullable; +import org.apache.iceberg.DeleteFile; +import org.apache.iceberg.FileScanTask; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.rest.PlanStatus; +import org.apache.iceberg.rest.RESTResponse; +import org.immutables.value.Value; + +@Value.Immutable +public interface FetchPlanningResultResponse extends RESTResponse { + PlanStatus planStatus(); + + @Nullable + List<String> planTasks(); + + @Nullable + List<FileScanTask> fileScanTasks(); + + @Nullable + List<DeleteFile> deleteFiles(); + + @Override + default void validate() { + Preconditions.checkArgument( + planStatus() != null, "invalid, status can not be null: ", planStatus()); + Preconditions.checkArgument( + planStatus() != PlanStatus.COMPLETED && (planTasks() != null || fileScanTasks() != null), + "invalid response, tasks can only be returned in a 'completed' status"); Review Comment: Thanks @amogh-jahagirdar for sharing your thoughts I feel like that was my understanding as well, the request and response require certain arguments to be present that the spec mandates, otherwise it is considered invalid and the `IllegalArgumentException` seems appropriate. When checking in the iceberg's core `rest` module, we already do this in serval places so it seems to be the pattern. Examples in the request classes https://github.com/apache/iceberg/blob/main/core/src/main/java/org/apache/iceberg/rest/requests/CommitTransactionRequest.java#L40 https://github.com/apache/iceberg/blob/main/core/src/main/java/org/apache/iceberg/rest/requests/CreateNamespaceRequest.java#L48 Examples in parser classes https://github.com/apache/iceberg/blob/main/core/src/main/java/org/apache/iceberg/rest/requests/CommitTransactionRequestParser.java#L44 https://github.com/apache/iceberg/blob/main/core/src/main/java/org/apache/iceberg/rest/requests/RegisterTableRequestParser.java#L43 @rdblue If this is an issue though can try to follow your suggestion as well, let me know what you think. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
