[composer][3/5]Implement paged Rpc method's sample code #513
There are no files selected for viewing
This file contains 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 |
|---|---|---|
|
|
@@ -18,8 +18,10 @@ | |
| import com.google.api.generator.engine.ast.CommentStatement; | ||
| import com.google.api.generator.engine.ast.Expr; | ||
| import com.google.api.generator.engine.ast.ExprStatement; | ||
| import com.google.api.generator.engine.ast.ForStatement; | ||
| import com.google.api.generator.engine.ast.LineComment; | ||
| import com.google.api.generator.engine.ast.MethodInvocationExpr; | ||
| import com.google.api.generator.engine.ast.Statement; | ||
| import com.google.api.generator.engine.ast.TryCatchStatement; | ||
| import com.google.api.generator.engine.ast.TypeNode; | ||
| import com.google.api.generator.engine.ast.Variable; | ||
|
|
@@ -35,6 +37,7 @@ | |
|
|
||
| public final class SampleCodeHelperComposer { | ||
| private static String RESPONSE_VAR_NAME = "response"; | ||
| private static String REQUEST_VAR_NAME = "request"; | ||
|
|
||
| public static TryCatchStatement composeRpcMethodSampleCode( | ||
| Method method, | ||
|
|
@@ -47,7 +50,7 @@ public static TryCatchStatement composeRpcMethodSampleCode( | |
| } | ||
| // Paged Unary RPC method. | ||
| if (method.isPaged()) { | ||
| return composePagedUnaryRpcMethodSampleCode(method, arguments, clientType, resourceNames); | ||
| } | ||
| // Long-running operation Unary RPC method. | ||
| if (method.hasLro()) { | ||
|
|
@@ -109,16 +112,34 @@ private static TryCatchStatement composeLroUnaryRpcMethodSampleCode( | |
| } | ||
|
|
||
| private static TryCatchStatement composePagedUnaryRpcMethodSampleCode( | ||
| Method method, | ||
| List<MethodArgument> arguments, | ||
| TypeNode clientType, | ||
| Map<String, ResourceName> resourceNames) { | ||
| // TODO(summerji): Add unit test. | ||
| VariableExpr clientVarExpr = createVariableExpr(getClientName(clientType), clientType); | ||
| // Assign each method arguments with default value. | ||
| List<Statement> bodyStatements = | ||
| arguments.stream() | ||
| .map( | ||
| methodArg -> | ||
| ExprStatement.withExpr( | ||
| assignMethodArgumentWithDefaultValue(methodArg, resourceNames))) | ||
| .collect(Collectors.toList()); | ||
| // For loop client on iterateAll method. | ||
| // e.g. for (LoggingServiceV2Client loggingServiceV2Client : | ||
| // loggingServiceV2Client.ListLogs(parent).iterateAll()) { | ||
| // //doThingsWith(element); | ||
| // } | ||
| bodyStatements.add( | ||
| ForStatement.builder() | ||
| .setLocalVariableExpr(clientVarExpr.toBuilder().setIsDecl(true).build()) | ||
| .setCollectionExpr(createIteratorAllMethodExpr(method, clientVarExpr, arguments)) | ||
| .setBody(Arrays.asList(createLineCommentStatement("doThingsWith(element);"))) | ||
| .build()); | ||
| return TryCatchStatement.builder() | ||
| .setTryResourceExpr(assignClientVariableWithCreateMethodExpr(clientVarExpr)) | ||
|
There was a problem hiding this comment. Same comment as in #512 about recreating the variables. |
||
| .setTryBody(bodyStatements) | ||
| .setIsSampleCode(true) | ||
| .build(); | ||
| } | ||
|
|
@@ -192,6 +213,24 @@ private static List<Expr> mapMethodArgumentsToVariableExprs(List<MethodArgument> | |
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| private static Expr createIteratorAllMethodExpr( | ||
| Method method, VariableExpr clientVarExpr, List<MethodArgument> arguments) { | ||
| // e.g echoClient.echo(name).iterateAll() | ||
| return MethodInvocationExpr.builder() | ||
| .setExprReferenceExpr( | ||
| MethodInvocationExpr.builder() | ||
| .setExprReferenceExpr(clientVarExpr) | ||
| .setMethodName(method.name()) | ||
|
There was a problem hiding this comment. TODO: JavaStyle.toLowerCarmelCase(method.name()) |
||
| .setArguments( | ||
| !arguments.isEmpty() | ||
| ? mapMethodArgumentsToVariableExprs(arguments) | ||
| : Arrays.asList(createVariableExpr("request", method.inputType()))) | ||
| .build()) | ||
| .setMethodName("iterateAll") | ||
| .setReturnType(clientVarExpr.variable().type()) | ||
| .build(); | ||
| } | ||
|
|
||
| private static String getClientName(TypeNode clientType) { | ||
| return JavaStyle.toLowerCamelCase(clientType.reference().name()); | ||
| } | ||
|
|
||
This file contains 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 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 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 |
|---|---|---|
|
|
@@ -435,7 +435,13 @@ public final WriteLogEntriesResponse writeLogEntries(WriteLogEntriesRequest requ | |
| * | ||
| * <pre>{@code | ||
| * try (LoggingServiceV2Client loggingServiceV2Client = LoggingServiceV2Client.create()) { | ||
| * List<String> resource_names = new ArrayList<>(); | ||
| * String filter = "filter-1274492040"; | ||
|
There was a problem hiding this comment. The samples currently use empty strings, existing example here. Consider detecting this case at the default value call site, or if this kind of different behavior occurs often, having a separate sample-specific variant of the default value method(s). |
||
| * String order_by = "order_by1234304744"; | ||
|
There was a problem hiding this comment. Can we stick with Java lowerCamelCase conventions? |
||
| * for (LoggingServiceV2Client loggingServiceV2Client : | ||
|
There was a problem hiding this comment. PTAL at the sample, the for-loop variable is not the client. |
||
| * loggingServiceV2Client.ListLogEntries(resource_names, filter, order_by).iterateAll()) { | ||
|
There was a problem hiding this comment. Ditto on the lowerCamelCasing for the variables. IIRC we'd discussed this in a previous review, but the invoked method should match the Java source as well (which the casing also affects). |
||
| * // doThingsWith(element); | ||
| * } | ||
| * } | ||
| * }</pre> | ||
| * | ||
|
|
@@ -568,7 +574,11 @@ public final ListMonitoredResourceDescriptorsPagedResponse listMonitoredResource | |
| * | ||
| * <pre>{@code | ||
| * try (LoggingServiceV2Client loggingServiceV2Client = LoggingServiceV2Client.create()) { | ||
| * BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]"); | ||
| * for (LoggingServiceV2Client loggingServiceV2Client : | ||
| * loggingServiceV2Client.ListLogs(parent).iterateAll()) { | ||
| * // doThingsWith(element); | ||
| * } | ||
| * } | ||
| * }</pre> | ||
| * | ||
|
|
@@ -594,7 +604,11 @@ public final ListLogsPagedResponse listLogs(BillingAccountName parent) { | |
| * | ||
| * <pre>{@code | ||
| * try (LoggingServiceV2Client loggingServiceV2Client = LoggingServiceV2Client.create()) { | ||
| * FolderName parent = FolderName.of("[FOLDER]"); | ||
| * for (LoggingServiceV2Client loggingServiceV2Client : | ||
| * loggingServiceV2Client.ListLogs(parent).iterateAll()) { | ||
| * // doThingsWith(element); | ||
| * } | ||
| * } | ||
| * }</pre> | ||
| * | ||
|
|
@@ -620,7 +634,11 @@ public final ListLogsPagedResponse listLogs(FolderName parent) { | |
| * | ||
| * <pre>{@code | ||
| * try (LoggingServiceV2Client loggingServiceV2Client = LoggingServiceV2Client.create()) { | ||
| * OrganizationName parent = OrganizationName.of("[ORGANIZATION]"); | ||
| * for (LoggingServiceV2Client loggingServiceV2Client : | ||
| * loggingServiceV2Client.ListLogs(parent).iterateAll()) { | ||
| * // doThingsWith(element); | ||
| * } | ||
| * } | ||
| * }</pre> | ||
| * | ||
|
|
@@ -646,7 +664,11 @@ public final ListLogsPagedResponse listLogs(OrganizationName parent) { | |
| * | ||
| * <pre>{@code | ||
| * try (LoggingServiceV2Client loggingServiceV2Client = LoggingServiceV2Client.create()) { | ||
| * ProjectName parent = ProjectName.of("[PROJECT]"); | ||
| * for (LoggingServiceV2Client loggingServiceV2Client : | ||
| * loggingServiceV2Client.ListLogs(parent).iterateAll()) { | ||
| * // doThingsWith(element); | ||
| * } | ||
| * } | ||
| * }</pre> | ||
| * | ||
|
|
@@ -672,7 +694,11 @@ public final ListLogsPagedResponse listLogs(ProjectName parent) { | |
| * | ||
| * <pre>{@code | ||
| * try (LoggingServiceV2Client loggingServiceV2Client = LoggingServiceV2Client.create()) { | ||
| * String parent = "parent-995424086"; | ||
| * for (LoggingServiceV2Client loggingServiceV2Client : | ||
| * loggingServiceV2Client.ListLogs(parent).iterateAll()) { | ||
| * // doThingsWith(element); | ||
| * } | ||
| * } | ||
| * }</pre> | ||
| * | ||
|
|
||
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.
PTAL at the comments on the sample snippet below.