public interface PaymentByKeyGet extends MetaModelGetDsl<Payment,Payment,PaymentByKeyGet,PaymentExpansionModel<Payment>>
withPayment(client(), paymentDraftBuilder -> paymentDraftBuilder.key(randomKey()), payment -> { final String key = payment.getKey(); final Payment loadedPayment = client().executeBlocking(PaymentByKeyGet.of(key)); assertThat(loadedPayment).isEqualTo(payment); return payment; });See the test code.
| Modifier and Type | Method and Description |
|---|---|
List<ExpansionPath<Payment>> |
expansionPaths() |
static PaymentByKeyGet |
of(String key) |
PaymentByKeyGet |
plusExpansionPaths(ExpansionPath<Payment> expansionPath)
Creates a new object with the properties of the old object but adds
expansionPath to the expansion paths. |
PaymentByKeyGet |
withExpansionPaths(ExpansionPath<Payment> expansionPath)
Creates a new object with the properties of the old object but replaces all expansion paths with a single
expansionPath. |
PaymentByKeyGet |
withExpansionPaths(List<ExpansionPath<Payment>> expansionPaths)
Creates a new object with the properties of the old object but replaces all expansion paths with
expansionPaths. |
deserializecanDeserialize, httpRequestIntentplusExpansionPaths, withExpansionPathsplusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPathsstatic PaymentByKeyGet of(String key)
List<ExpansionPath<Payment>> expansionPaths()
expansionPaths in interface ExpansionPathContainer<Payment>expansionPaths in interface ReferenceExpansionSupport<Payment>PaymentByKeyGet plusExpansionPaths(ExpansionPath<Payment> expansionPath)
ReferenceExpansionDslexpansionPath to the expansion paths.
An example in the product projection context:
final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT); assertThat(fetch.expansionPaths()).isEmpty(); final ProductProjectionByIdGet fetch2 = fetch.plusExpansionPaths(ProductProjectionExpansionModel.of().categories()); assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged").isEmpty(); assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("categories[*]"))); assertThat(fetch2).isNotSameAs(fetch);See the test code.
plusExpansionPaths in interface ReferenceExpansionDsl<Payment,PaymentByKeyGet>expansionPath - the new expansion path to add to the existing onesPaymentByKeyGet withExpansionPaths(ExpansionPath<Payment> expansionPath)
ReferenceExpansionDslexpansionPath.
An example in the product projection context:
final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT) .withExpansionPaths(ProductProjectionExpansionModel.of().categories()); assertThat(fetch.expansionPaths()) .isEqualTo(asList(ExpansionPath.of("categories[*]"))); final ProductProjectionByIdGet fetch2 = fetch.withExpansionPaths(ProductProjectionExpansionModel.of().productType()); assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged") .isEqualTo(asList(ExpansionPath.of("categories[*]"))); assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("productType"))); assertThat(fetch2).isNotSameAs(fetch);See the test code.
This method also can be used to use the same expansions as in another request:
final ProductProjectionQuery query = ProductProjectionQuery.ofCurrent().withExpansionPaths(m -> m.categories()); final ProductProjectionSearch search = ProductProjectionSearch.ofCurrent().withExpansionPaths(query); assertThat(query.expansionPaths()) .hasSize(1) .as("reuse expansion spec from other request") .isEqualTo(search.expansionPaths());See the test code.
withExpansionPaths in interface ReferenceExpansionDsl<Payment,PaymentByKeyGet>expansionPath - the new expansion pathsPaymentByKeyGet withExpansionPaths(List<ExpansionPath<Payment>> expansionPaths)
ReferenceExpansionDslexpansionPaths.withExpansionPaths in interface ReferenceExpansionDsl<Payment,PaymentByKeyGet>expansionPaths - the new expansion paths