io.sphere.sdk.apiclient.queries

Interface ApiClientByIdGet

All Superinterfaces:

ExpansionPathContainer<ApiClient>, Get<ApiClient>, GetDsl<ApiClient,ApiClient,ApiClientByIdGet>, MetaModelGetDsl<ApiClient,ApiClient,ApiClientByIdGet,ApiClientExpansionModel<ApiClient>>, MetaModelReferenceExpansionDsl<ApiClient,ApiClientByIdGet,ApiClientExpansionModel<ApiClient>>, ReferenceExpansionDsl<ApiClient,ApiClientByIdGet>, ReferenceExpansionSupport<ApiClient>, SphereRequest<ApiClient>

public interface ApiClientByIdGet
extends MetaModelGetDsl<ApiClient,ApiClient,ApiClientByIdGet,ApiClientExpansionModel<ApiClient>>

Retrieves a extension by a known ID.

Method Summary

Modifier and Type	Method and Description
List<ExpansionPath<ApiClient>>	expansionPaths()
static ApiClientByIdGet	of(Identifiable<ApiClient> resource)
static ApiClientByIdGet	of(String id)
ApiClientByIdGet	plusExpansionPaths(ExpansionPath<ApiClient> expansionPath) Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.
ApiClientByIdGet	withExpansionPaths(ExpansionPath<ApiClient> expansionPath) Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.
ApiClientByIdGet	withExpansionPaths(List<ExpansionPath<ApiClient>> expansionPaths) Creates a new object with the properties of the old object but replaces all expansion paths with expansionPaths.

Methods inherited from interface io.sphere.sdk.queries.Get

deserialize

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, httpRequestIntent

Methods inherited from interface io.sphere.sdk.expansion.MetaModelReferenceExpansionDsl

plusExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl

plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths

Method Detail

of

static ApiClientByIdGet of(String id)

of

static ApiClientByIdGet of(Identifiable<ApiClient> resource)

expansionPaths

List<ExpansionPath<ApiClient>> expansionPaths()

Specified by:

expansionPaths in interface ExpansionPathContainer<ApiClient>

Specified by:

expansionPaths in interface ReferenceExpansionSupport<ApiClient>

plusExpansionPaths

ApiClientByIdGet plusExpansionPaths(ExpansionPath<ApiClient> expansionPath)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but adds expansionPath 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.

Specified by:

plusExpansionPaths in interface ReferenceExpansionDsl<ApiClient,ApiClientByIdGet>

Parameters:

expansionPath - the new expansion path to add to the existing ones

Returns:

new object

withExpansionPaths

ApiClientByIdGet withExpansionPaths(ExpansionPath<ApiClient> expansionPath)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.

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.

Specified by:

withExpansionPaths in interface ReferenceExpansionDsl<ApiClient,ApiClientByIdGet>

Parameters:

expansionPath - the new expansion paths

Returns:

new object

withExpansionPaths

ApiClientByIdGet withExpansionPaths(List<ExpansionPath<ApiClient>> expansionPaths)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but replaces all expansion paths with expansionPaths.

Specified by:

withExpansionPaths in interface ReferenceExpansionDsl<ApiClient,ApiClientByIdGet>

Parameters:

expansionPaths - the new expansion paths

Returns:

new object