Skip to main content

io.enterpriseai.resources.CatalogClient

Source: sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/CatalogClient.java. Back to the Java SDK reference index.

note

This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.

Class CatalogClient​

Brick catalog (A to H).

Constructor CatalogClient​

CatalogClient(Transport transport)

Creates the client on the shared transport; EnterpriseAIClient builds it and exposes it through the accessor of the same name.

NameTypeDefaultRequiredDescription
transportTransportyesTransport shared by the sub-clients of one client.

CatalogClient.brick​

JsonNode brick(String id)

Get one platform brick. One brick of the catalog, matched on its id without regard to case. Answers 404 not_found when no brick has this id. No authentication required.

Route: /v1/catalog/bricks/{brick_id} (GET).

NameTypeDefaultRequiredDescription
idStringyesIdentifier of the brick in the catalog, case insensitive.

Returns: JsonNode. Decoded JSON answer of the operation "Get one platform brick".

Raises: the typed errors of the transport (Errors).

CatalogClient.bricks​

JsonNode bricks()

List the platform bricks. Catalog of the platform bricks read from bricks.yaml of the catalog folder, in one page (next_cursor is always null). The file is loaded as safe YAML (no anchors or aliases, 2 MB at most). No authentication required.

Route: /v1/catalog/bricks (GET).

This element takes no parameter.

Returns: JsonNode. Decoded JSON answer of the operation "List the platform bricks".

Raises: the typed errors of the transport (Errors).