-
Notifications
You must be signed in to change notification settings - Fork 962
Adding codegen updates and configuration options #4085
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
davidh44
merged 8 commits into
feature/master/request-compression
from
hdavidh/codegen-and-configurations
Jun 14, 2023
Merged
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c04107f
Adding configuration options
davidh44 359c838
Adding codegen updates
davidh44 4082cd5
Adding javadocs
davidh44 2629a57
Fix CheckStyle/SpotBugs errors, and add RequestCompression intercepto…
davidh44 3c2f4d1
RequestCompression interceptor trait
davidh44 c2313b3
Refactoring, adding profile config and javadocs
davidh44 cd59faa
Refactoring and add codegen tests
davidh44 19f3e49
Add codegen tests
davidh44 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
codegen/src/main/java/software/amazon/awssdk/codegen/compression/RequestCompression.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.codegen.compression; | ||
|
|
||
| import java.util.List; | ||
| import software.amazon.awssdk.annotations.SdkInternalApi; | ||
|
|
||
| /** | ||
| * Class to map the RequestCompression trait of an operation. | ||
| */ | ||
| @SdkInternalApi | ||
| public class RequestCompression { | ||
|
|
||
| private List<String> encodings; | ||
|
|
||
| public List<String> getEncodings() { | ||
| return encodings; | ||
| } | ||
|
|
||
| public void setEncodings(List<String> encodings) { | ||
| this.encodings = encodings; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
59 changes: 59 additions & 0 deletions
59
.../main/java/software/amazon/awssdk/codegen/poet/client/traits/RequestCompressionTrait.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.codegen.poet.client.traits; | ||
|
|
||
| import com.squareup.javapoet.CodeBlock; | ||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
| import software.amazon.awssdk.codegen.model.intermediate.OperationModel; | ||
| import software.amazon.awssdk.core.client.config.SdkClientOption; | ||
| import software.amazon.awssdk.core.client.handler.ClientExecutionParams; | ||
| import software.amazon.awssdk.core.interceptor.SdkExecutionAttribute; | ||
| import software.amazon.awssdk.core.interceptor.SdkInternalExecutionAttribute; | ||
| import software.amazon.awssdk.core.interceptor.trait.RequestCompression; | ||
|
|
||
| /** | ||
| * The logic for handling the "requestCompression" trait within the code generator. | ||
| */ | ||
| public class RequestCompressionTrait { | ||
|
|
||
| private RequestCompressionTrait() { | ||
| } | ||
|
|
||
| /** | ||
| * Generate a ".putExecutionAttribute(...)" code-block for the provided operation model. This should be used within the | ||
| * context of initializing {@link ClientExecutionParams}. If request compression is not required by the operation, this will | ||
| * return an empty code-block. | ||
| */ | ||
| public static CodeBlock create(OperationModel operationModel) { | ||
| if (operationModel.getRequestCompression() == null) { | ||
| return CodeBlock.of(""); | ||
| } | ||
|
|
||
| List<String> encodings = operationModel.getRequestCompression().getEncodings(); | ||
|
|
||
| return CodeBlock.builder() | ||
| .add(CodeBlock.of(".putExecutionAttribute($T.REQUEST_COMPRESSION, " | ||
| + "$T.builder().encodings($L).isStreaming($L).build())", | ||
| SdkInternalExecutionAttribute.class, RequestCompression.class, | ||
| encodings.stream().collect(Collectors.joining("\", \"", "\"", "\"")), | ||
| operationModel.hasStreamingInput())) | ||
| .add(CodeBlock.of(".putExecutionAttribute($T.REQUEST_COMPRESSION_CONFIGURATION," | ||
| + "clientConfiguration.option($T.REQUEST_COMPRESSION_CONFIGURATION))", | ||
| SdkExecutionAttribute.class, SdkClientOption.class)) | ||
| .build(); | ||
| } | ||
| } | ||
123 changes: 123 additions & 0 deletions
123
core/sdk-core/src/main/java/software/amazon/awssdk/core/RequestCompressionConfiguration.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| package software.amazon.awssdk.core; | ||
|
|
||
| import java.util.Objects; | ||
| import software.amazon.awssdk.annotations.SdkPublicApi; | ||
| import software.amazon.awssdk.utils.builder.CopyableBuilder; | ||
| import software.amazon.awssdk.utils.builder.ToCopyableBuilder; | ||
|
|
||
| /** | ||
| * Configuration options for operations with the RequestCompression trait to disable request configuration and set the minimum | ||
| * compression threshold in bytes. | ||
| */ | ||
| @SdkPublicApi | ||
| public class RequestCompressionConfiguration implements ToCopyableBuilder<RequestCompressionConfiguration.Builder, | ||
zoewangg marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| RequestCompressionConfiguration> { | ||
|
|
||
| private final Boolean requestCompressionEnabled; | ||
| private final Integer minimumCompressionThresholdInBytes; | ||
|
|
||
| private RequestCompressionConfiguration(DefaultBuilder builder) { | ||
| this.requestCompressionEnabled = builder.requestCompressionEnabled; | ||
| this.minimumCompressionThresholdInBytes = builder.minimumCompressionThresholdInBytes; | ||
| } | ||
|
|
||
| /** | ||
| * If set, returns true if request compression is enabled, else false if request compression is disabled. | ||
| */ | ||
| public Boolean requestCompressionEnabled() { | ||
| return requestCompressionEnabled; | ||
| } | ||
|
|
||
| /** | ||
| * If set, returns the minimum compression threshold in bytes, inclusive, in order to trigger request compression. | ||
| */ | ||
| public Integer getMinimumCompressionThresholdInBytes() { | ||
zoewangg marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| return minimumCompressionThresholdInBytes; | ||
| } | ||
|
|
||
| /** | ||
| * Create a {@link RequestCompressionConfiguration.Builder}, used to create a {@link RequestCompressionConfiguration}. | ||
| */ | ||
| public static Builder builder() { | ||
| return new DefaultBuilder(); | ||
| } | ||
|
|
||
| @Override | ||
| public Builder toBuilder() { | ||
| return new DefaultBuilder(this); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
|
|
||
| RequestCompressionConfiguration that = (RequestCompressionConfiguration) o; | ||
|
|
||
| if (requestCompressionEnabled != that.requestCompressionEnabled) { | ||
| return false; | ||
| } | ||
| return Objects.equals(minimumCompressionThresholdInBytes, that.minimumCompressionThresholdInBytes); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| int result = requestCompressionEnabled != null ? requestCompressionEnabled.hashCode() : 0; | ||
| result = 31 * result + (minimumCompressionThresholdInBytes != null ? minimumCompressionThresholdInBytes.hashCode() : 0); | ||
| return result; | ||
| } | ||
|
|
||
|
|
||
| public interface Builder extends CopyableBuilder<Builder, RequestCompressionConfiguration> { | ||
|
|
||
| /** | ||
| * Configures whether request compression is enabled or not. | ||
| * | ||
| * @param requestCompressionEnabled | ||
zoewangg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * @return This object for method chaining. | ||
| */ | ||
| Builder requestCompressionEnabled(Boolean requestCompressionEnabled); | ||
|
|
||
| /** | ||
| * Configures the minimum compression threshold in bytes. | ||
| * | ||
| * @param minimumCompressionThresholdInBytes | ||
| * @return This object for method chaining. | ||
| */ | ||
| Builder minimumCompressionThresholdInBytes(Integer minimumCompressionThresholdInBytes); | ||
| } | ||
|
|
||
| private static final class DefaultBuilder implements Builder { | ||
| private Boolean requestCompressionEnabled; | ||
| private Integer minimumCompressionThresholdInBytes; | ||
|
|
||
| private DefaultBuilder() { | ||
| } | ||
|
|
||
| private DefaultBuilder(RequestCompressionConfiguration requestCompressionConfiguration) { | ||
| this.requestCompressionEnabled = requestCompressionConfiguration.requestCompressionEnabled; | ||
| this.minimumCompressionThresholdInBytes = requestCompressionConfiguration.minimumCompressionThresholdInBytes; | ||
| } | ||
|
|
||
| @Override | ||
| public Builder requestCompressionEnabled(Boolean requestCompressionEnabled) { | ||
| this.requestCompressionEnabled = requestCompressionEnabled; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public Builder minimumCompressionThresholdInBytes(Integer minimumCompressionThresholdInBytes) { | ||
zoewangg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| this.minimumCompressionThresholdInBytes = minimumCompressionThresholdInBytes; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public RequestCompressionConfiguration build() { | ||
| return new RequestCompressionConfiguration(this); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add some tests to show generated code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added request compression operation to the query service-2.json, updated generated test files