Bỏ qua để đến nội dung
AggregaAggrega
Chọn ngôn ngữ: Tiếng Việt
Trang này được dịch bằng máy. Đọc bản gốc tiếng Anh.

Lược đồ Aggrega Wasm Importer Socket

Tài liệu tham khảo được sinh tự động. Không chỉnh sửa thủ công — hãy sinh lại từ JSON Schema đã xuất bản.

Id lược đồ: https://aggrega.ai/schemas/wasm-import-v1beta1.schema.json

Các dạng dữ liệu truyền mà một socket của plugin trình nhập tiêu thụ (ImportInput) và phát ra (ImportOutput). Một trình nhập chuyển một bản mô tả hạ tầng bên ngoài thành các thực thể Aggrega: nó đọc các byte nguồn cho một định dạng được đặt tên, ánh xạ từng nút nguồn thành một thực thể trong danh mục, và trả về các thực thể nó đã phát ra, các quyết định ánh xạ nó đã đưa ra, mọi chẩn đoán nó đã nêu, và mọi tệp khung nó đã tạo. Một trình nhập khai báo các định dạng nó xử lý dưới dạng các khả năng import: trong bộ mô tả của nó. Trình nhập ánh xạ ý nghĩa từ nguồn sang các thực thể; trình biên dịch chuyển tiếp các thực thể được phát ra một cách không can thiệp vào nội dung.

Một trong các dạng sau

  • ImportInput
  • ImportOutput

Định nghĩa

ImportInput

Payload mà một guest importer nhận được: định dạng nguồn quyết định cách đọc các byte, các byte nguồn chính và tên của tệp mà chúng được đọc từ đó, mọi nguồn có tên cho một lần import nhiều tệp, một tài liệu tùy chọn mờ (không bắt buộc) mà bên sử dụng cung cấp cho hành vi riêng của importer, một góc nhìn về các Components mà catalog của workspace chứa, và đích mà lần import soạn bản nháp hướng tới.

Thuộc tínhLoạiBắt buộcMô tả
formatstringcóTên của định dạng nguồn cần import, khớp với một trong các khả năng import: mà importer công bố. Importer đọc các nguồn theo định dạng này.
bytesstringcóCác byte nguồn chính cần import, mà importer đọc theo định dạng đã nêu tên: toàn bộ tệp khi nguồn của lần import là một tệp, và rỗng khi nguồn là một thư mục, khi đó các tệp của thư mục đến dưới dạng các nguồn có tên. Mỗi kit mang chúng trong kiểu trường riêng của nó — ở dạng thô khi kiểu đó là kiểu byte, mã hóa base64 khi đó là một chuỗi mà importer giải mã để khôi phục chúng — và bộ mã hóa được sinh ra chuyển đổi giữa trường đó và dạng mà wire dùng để mang byte.
namestringkhôngTên của nguồn import, không kèm thư mục phía trước, để importer có thể nêu tên nguồn trong những gì nó báo cáo và trong những gì nó phác thảo. Khi nguồn là một tệp, đây là tên cơ sở của tệp: các byte chính không đến dưới dạng nguồn có tên, nên đây là tên duy nhất chúng mang. Khi nguồn là một thư mục, đây là tên cơ sở của thư mục, và các tệp của thư mục vẫn đến dưới dạng các nguồn có tên, mỗi tệp dưới tên riêng của nó, với các byte chính để trống. Vắng mặt khi nguồn không có tên nào để cung cấp.
sourcesImportSource[]khôngCác nguồn có tên, mỗi nguồn mang các byte riêng, trong một danh sách sắp xếp theo tên. Khi nguồn của lần import là một thư mục, có một nguồn cho mỗi tệp trong thư mục được các mẫu tệp mà importer khai báo chọn, được đặt tên theo đường dẫn phân tách bằng dấu gạch chéo bên trong thư mục. Các tệp mà attachment cấu hình importer khai báo dưới with.sources cũng được mang ở đây, mỗi tệp dưới tên gốc của nó, và host từ chối một lần import trong đó một tệp đọc từ thư mục và một trong các tệp này có cùng tên. Vắng mặt khi không bên nào cung cấp nguồn nào.
settingsanykhôngMột tài liệu tùy chọn import mờ mà bên sử dụng cung cấp cho hành vi riêng của importer. Host chuyển tiếp nó mà không diễn giải; importer đọc theo bất kỳ dạng nào mà nó mô tả trong tài liệu. Vắng mặt khi bên sử dụng không cung cấp tùy chọn nào.
catalogCatalogProjectionkhôngMột góc nhìn về các Components mà chính catalog của workspace chứa — catalog mà importer được chọn ra từ đó — để importer có thể cân nhắc chúng như các ứng viên khi ánh xạ một nút nguồn sang một thực thể catalog. Host xây dựng nó chỉ từ catalog cục bộ đó, và nó chỉ mang tên, phiên bản, nhãn và cấu trúc đã khai báo: không bao giờ mang một giá trị, một giá trị mặc định hay một bí mật. Thứ tự của nó cố định, nên một catalog tạo ra một chuỗi byte duy nhất. Vắng mặt khi catalog không chứa Component nào.
targetstringkhôngKhả năng của nhà cung cấp mà lần import soạn bản nháp hướng tới, chẳng hạn compose hoặc helm: đích được chỉ định cho lần import, hoặc, với một lần import làm mới một lần import trước đó và tự nó không chỉ định đích nào, đích mà lần import trước đó đã ghi lại. Importer ghi vào các bản nháp dưới dạng khai báo những gì chỉ đích đó cần, và bỏ qua những gì chỉ một đích khác cần. Host chuyển tiếp nó nguyên trạng, sau khi đã kiểm tra rằng một Recipe trong catalog của workspace liên kết với nó. Không có khi lần import không chỉ định đích nào.

Không cho phép thuộc tính bổ sung.

CatalogProjection

Catalog của workspace theo cách một importer nhìn thấy: một mục cho mỗi Component mà catalog chứa, mỗi mục mang siêu dữ liệu mà importer cân nhắc khi chấm điểm một ứng viên.

Thuộc tínhLoạiBắt buộcMô tả
componentsCatalogComponent[]cóMột mục cho mỗi tên Component mà catalog chứa, sắp xếp theo tên. Khi catalog chứa nhiều phiên bản của một Component, mục của nó mô tả phiên bản mà một tham chiếu nêu tên Component không kèm phiên bản được phân giải tới.

Không cho phép thuộc tính bổ sung.

CatalogComponent

Một Component của catalog của workspace: tên và phiên bản, các nhãn, các tên khóa mà values và provides của nó khai báo, và các socket mà nó khai báo cho các phụ thuộc. Một Component mở rộng một Component khác mang cả những gì nó kế thừa lẫn những gì nó tự khai báo.

Thuộc tínhLoạiBắt buộcMô tả
namestringcóTên của Component, như metadata.name của nó khai báo — tên mà một Aggregate dùng để tham chiếu nó.
versionstringcóPhiên bản của Component, như metadata.version của nó khai báo.
labelsmap của stringkhôngCác nhãn của Component, dưới dạng một map từ chuỗi sang chuỗi. Vắng mặt khi nó không mang nhãn nào.
valuesstring[]khôngCác tên khóa cấp cao nhất mà values của Component khai báo, đã sắp xếp. Chỉ là một danh sách tên: không bao giờ mang một giá trị hay một giá trị mặc định. Vắng mặt khi values của nó không khai báo khóa nào.
providesstring[]khôngCác tên khóa cấp cao nhất mà provides của Component khai báo, đã sắp xếp. Chỉ là một danh sách tên: không bao giờ mang một giá trị. Vắng mặt khi provides của nó không khai báo khóa nào.
socketsCatalogSocket[]khôngCác socket mà Component khai báo cho các phụ thuộc của nó, theo thứ tự khai báo: với một Component mở rộng một Component khác, các socket nó kế thừa đứng trước, theo thứ tự mà Component được mở rộng khai báo chúng, tiếp theo là các socket nó thêm vào. Vắng mặt khi nó không khai báo socket nào.

Không cho phép thuộc tính bổ sung.

CatalogSocket

Một socket mà một Component trong catalog khai báo cho các phụ thuộc của nó: tên của socket và bộ chọn nhãn mà một phụ thuộc được nối qua socket đó phải thỏa mãn.

Thuộc tínhLoạiBắt buộcMô tả
namestringcóTên của socket, như usesSchema của Component khai báo.
selectorstringcóBộ chọn nhãn của socket, nguyên văn, theo cú pháp kiểu Kubernetes mà Component dùng để viết nó: các nhãn mà một phụ thuộc được nối qua socket này phải mang.

Không cho phép thuộc tính bổ sung.

ImportSource

Một nguồn có tên trong một lần import nhiều tệp hoặc import thư mục: một tên định vị nguồn và các byte riêng của nó.

Thuộc tínhLoạiBắt buộcMô tả
namestringcóTên của nguồn này trong lần import, chẳng hạn một đường dẫn tệp tương đối.
bytesstringcóCác byte của nguồn này. Mỗi kit mang chúng trong kiểu trường riêng của nó — ở dạng thô khi kiểu đó là kiểu byte, mã hóa base64 khi đó là một chuỗi mà importer giải mã để khôi phục chúng — và bộ mã hóa được sinh ra chuyển đổi giữa trường đó và dạng mà wire dùng để mang byte.

Không cho phép thuộc tính bổ sung.

ImportOutput

Payload mà một guest importer trả về: các thực thể mà lần import tạo ra, các quyết định ánh xạ đằng sau chúng, mọi chẩn đoán mà lần import phát sinh, và mọi tệp scaffold mà nó tạo ra. Mọi trường đều không bắt buộc, nên một lần import không phân giải được gì có thể chỉ trả về các chẩn đoán.

Thuộc tínhLoạiBắt buộcMô tả
entitiesEmittedEntity[]khôngCác thực thể mà lần import tạo ra, mỗi thực thể hoặc là một tham chiếu tới một thực thể catalog có sẵn, hoặc là một phần thân thực thể được soạn thảo. Vắng mặt khi lần import không phát ra thực thể nào.
decisionsImportDecision[]khôngCác quyết định ánh xạ mà lần import đưa ra, một quyết định cho mỗi nút nguồn mà nó phân giải, ghi lại các ứng viên nó đã cân nhắc và lựa chọn nó đã đưa ra. Vắng mặt khi lần import không ghi lại quyết định nào.
diagnosticsDiagnostic[]khôngCác chẩn đoán mà lần import phát sinh — ví dụ một nút nguồn không được phân giải hoặc một ánh xạ mơ hồ. Vắng mặt khi lần import không tạo ra chẩn đoán nào.
filesScaffoldFile[]khôngCác tệp scaffold mà lần import tạo ra cùng với các thực thể, chẳng hạn một aggregate khởi đầu hoặc một tệp readme. Vắng mặt khi lần import không tạo ra tệp nào.
errorstringkhôngMột thông điệp lỗi được đặt khi guest đã chạy nhưng không thể hoàn tất thao tác; vắng mặt khi thành công. Nó khác với mọi chẩn đoán mà đầu ra mang theo: chẩn đoán báo cáo các vấn đề phát hiện trong một lần chạy vẫn tạo ra kết quả, còn error báo cáo rằng bản thân thao tác đã không hoàn tất. Host hiển thị một error có mặt như một lần gọi plugin thất bại.

Không cho phép thuộc tính bổ sung.

EmittedEntity

Một thực thể mà lần import tạo ra: loại, tên của nó, và cách nó được phát ra — một tham chiếu tới một thực thể catalog có sẵn hoặc một phần thân thực thể mới được soạn thảo.

Thuộc tínhLoạiBắt buộcMô tả
kindstringcóLoại thực thể được phát ra. Các importer lõi phát ra Component, Aggregate và Release; bên đọc chấp nhận bất kỳ loại nào khác.
namestringcóTên của thực thể được phát ra.
modestring (enum)cóCách thực thể được phát ra: reference trỏ tới một thực thể catalog có sẵn theo tên, còn draft mang một phần thân thực thể mới được soạn thảo. Giá trị cho phép: "reference", "draft"
bodystringkhôngPhần thân YAML thô của một thực thể được soạn thảo. Rỗng đối với một tham chiếu thuần túy, vốn nêu tên một thực thể có sẵn thay vì soạn thảo một thực thể mới.
labelsmap của stringkhôngCác nhãn gắn vào thực thể được phát ra, dưới dạng một map từ chuỗi sang chuỗi. Các importer lõi để trống trường này.
annotationsmap của stringkhôngCác annotation gắn vào thực thể được phát ra, dưới dạng một map từ chuỗi sang chuỗi. Các importer lõi để trống trường này.
sourceRefstringkhôngMột tham chiếu tới nút nguồn mà thực thể này được phát ra từ đó, để bên đọc có thể truy ngược thực thể về nguồn gốc của nó trong nguồn được import.
decisionRefstringkhôngMột tham chiếu tới quyết định ánh xạ đã tạo ra thực thể này, liên kết nó với các ứng viên đã được cân nhắc và lựa chọn đã được đưa ra.

Không cho phép thuộc tính bổ sung.

ImportDecision

Một quyết định ánh xạ: nút nguồn mà importer đã phân giải, các thực thể catalog ứng viên mà nó đã cân nhắc, ứng viên mà nó đã chọn, và lập luận đằng sau lựa chọn đó.

Thuộc tínhLoạiBắt buộcMô tả
sourceNodeDecisionSourceNodecóNút nguồn mà quyết định này đã phân giải: nút mà importer đã đọc từ nguồn và ánh xạ tới một thực thể catalog.
candidatesImportCandidate[]khôngCác thực thể catalog ứng viên mà importer đã cân nhắc cho nút nguồn này, mỗi thực thể kèm điểm số và bảng phân tích theo từng tín hiệu đằng sau điểm số đó. Vắng mặt khi importer không cân nhắc ứng viên nào.
chosenDecisionChoicekhôngỨng viên mà importer đã chọn cho nút nguồn này, và cách nó phát ra ứng viên đó. Vắng mặt khi importer không đưa ra lựa chọn nào.
rationalestringkhôngMột lời giải thích dễ đọc cho con người về lý do importer đưa ra lựa chọn này.
swapHintstringkhôngMột gợi ý mô tả cách thay ánh xạ đã chọn bằng một phương án khác, để người đọc có thể sửa đổi quyết định.

Không cho phép thuộc tính bổ sung.

DecisionSourceNode

Nút nguồn mà một quyết định ánh xạ đã phân giải: một định danh, loại mà nguồn đặt cho nó, và một bản tóm tắt dễ đọc cho con người về các tham số của nó.

Thuộc tínhLoạiBắt buộcMô tả
idstringcóĐịnh danh của nút nguồn trong nguồn được nhập.
typestringcóLoại của nút nguồn theo cách nguồn đặt tên cho nó.
paramsSummarystringcóMột bản tóm tắt dễ đọc cho con người về các tham số của nút nguồn, để hiển thị cùng với quyết định.

Không cho phép thuộc tính bổ sung.

ImportCandidate

Một thực thể catalog ứng viên mà importer đã cân nhắc cho một nút nguồn: component ứng viên, điểm tổng thể của nó, bậc khớp mà điểm số thuộc về, và bảng phân tích theo từng tín hiệu đằng sau điểm số.

Thuộc tínhLoạiBắt buộcMô tả
componentNamestringcóTên của component catalog ứng viên.
scorenumbercóĐiểm khớp tổng thể của ứng viên, được tổng hợp từ bảng phân tích theo từng tín hiệu.
tierstringcóBậc khớp mà ứng viên thuộc về, một dải thô trên điểm số.
signalsCandidateSignalscóBảng phân tích theo từng tín hiệu đằng sau điểm số của ứng viên.

Không cho phép thuộc tính bổ sung.

CandidateSignals

Bảng phân tích theo từng tín hiệu đằng sau điểm số của một ứng viên: một phần đóng góp cho mỗi tín hiệu khớp. Đây là một đối tượng có các trường cố định, nên tập hợp tín hiệu ổn định và dữ liệu truyền đi mang tính tất định.

Thuộc tínhLoạiBắt buộcMô tả
tablenumbercóPhần đóng góp vào điểm số từ tín hiệu bảng ánh xạ.
categorynumbercóPhần đóng góp vào điểm số từ tín hiệu danh mục.
domainLabelsnumbercóPhần đóng góp vào điểm số từ tín hiệu nhãn miền.
shapenumbercóPhần đóng góp vào điểm số từ tín hiệu hình dạng.
namenumbercóPhần đóng góp vào điểm số từ tín hiệu tên.

Không cho phép thuộc tính bổ sung.

DecisionChoice

Ứng viên mà một quyết định ánh xạ đã chọn: thực thể catalog đích, cách nó được phát ra, và bậc khớp của lựa chọn.

Thuộc tínhLoạiBắt buộcMô tả
targetstringcóTên của thực thể catalog đích đã chọn.
modestringcóCách đích đã chọn được phát ra, tương ứng với chế độ của một thực thể được phát ra: một tham chiếu tới một thực thể hiện có hoặc một phần thân mới được soạn thảo.
tierstringcóBậc khớp của đích đã chọn.

Không cho phép thuộc tính bổ sung.

ScaffoldFile

Một tệp khung mà quá trình nhập đã tạo ra: một đường dẫn tương đối so với thư mục gốc đầu ra của quá trình nhập và nội dung của tệp.

Thuộc tínhLoạiBắt buộcMô tả
pathstringcóĐường dẫn của tệp khung, tương đối so với thư mục gốc đầu ra của quá trình nhập.
contentstringcóNội dung của tệp khung.

Không cho phép thuộc tính bổ sung.