이 문서에서는 Pub/Sub 주제의 스키마를 만드는 방법을 보여줍니다.
시작하기 전에
스키마를 만들기 전에 다음을 완료합니다.
- 주제 및 게시 워크플로를 알아봅니다.
- Pub/Sub 스키마의 작동 방식을 이해합니다.
- 주제 만들기
필수 역할 및 권한
스키마 생성 및 관리를 위해 필요한 권한을 얻으려면 관리자에게 프로젝트에 대한 Pub/Sub 편집자(roles/pubsub.editor
) IAM 역할을 부여해 달라고 요청하세요.
역할 부여에 대한 자세한 내용은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.
이 사전 정의된 역할에는 스키마 생성 및 관리를 위해 필요한 권한이 포함되어 있습니다. 필요한 정확한 권한을 보려면 필수 권한 섹션을 펼치세요.
필수 권한
스키마를 만들고 관리하려면 다음 권한이 필요합니다.
-
스키마 만들기:
pubsub.schemas.create
-
주제에 스키마 연결:
pubsub.schemas.attach
-
스키마 버전 커밋:
pubsub.schemas.commit
-
스키마 또는 스키마 버전 삭제:
pubsub.schemas.delete
-
스키마 또는 스키마 버전 가져오기:
pubsub.schemas.get
-
스키마 나열:
pubsub.schemas.list
-
스키마 버전 나열:
pubsub.schemas.listRevisions
-
스키마 롤백:
pubsub.schemas.rollback
-
메시지 유효성 검사:
pubsub.schemas.validate
-
스키마의 IAM 정책 가져오기:
pubsub.schemas.getIamPolicy
-
스키마의 IAM 정책 구성:
pubsub.schemas.setIamPolicy
커스텀 역할이나 다른 사전 정의된 역할을 사용하여 이 권한을 부여받을 수도 있습니다.
사용자, 그룹, 도메인, 서비스 계정과 같은 주 구성원에 역할 및 권한을 부여할 수 있습니다. 한 프로젝트에서 스키마를 만들고 이를 다른 프로젝트에 있는 주제에 연결할 수 있습니다. 각 프로젝트에 필요한 권한이 있는지 확인합니다.
스키마 만들기
Google Cloud 콘솔, gcloud CLI, Pub/Sub API, Cloud 클라이언트 라이브러리를 사용하여 스키마를 만들 수 있습니다.
스키마를 만들기 전에 스키마에 관한 중요한 정보를 검토하세요.
콘솔
대시보드를 만들려면 다음 단계별 안내를 따르세요.
Google Cloud 콘솔에서 Pub/Sub 스키마 페이지로 이동합니다.
스키마 만들기를 클릭합니다.
스키마 ID 필드에 스키마 ID를 입력합니다.
스키마 이름 지정에 대한 가이드라인은 주제, 구독, 스냅샷 이름 지정 가이드라인을 참조하세요.
스키마 유형에 Avro 또는 프로토콜 버퍼를 선택합니다.
스키마 유형에 대해 자세히 알아보세요.
스키마 정의 필드에 스키마에 대한 Avro 또는 프로토콜 버퍼 정의를 입력합니다.
예를 들어 다음은 Avro의 샘플 스키마입니다.
{ "type": "record", "name": "Avro", "fields": [ { "name": "ProductName", "type": "string", "default": "" }, { "name": "SKU", "type": "int", "default": 0 }, { "name": "InStock", "type": "boolean", "default": false } ] }
선택사항: 스키마 정의가 올바른지 확인하려면 정의 유효성 검사를 클릭합니다.
유효성 검사를 수행해도 게시할 메시지가 스키마와 호환되는지는 검사되지 않습니다. 다음 단계에서 메시지를 테스트합니다.
선택사항: 스키마가 올바른 메시지가 게시되는지 테스트할 수 있습니다.
테스트 메시지를 클릭합니다.
메시지 테스트 창에서 메시지 인코딩 유형을 선택합니다.
메시지 본문에 테스트 메시지를 입력합니다.
테스트를 클릭합니다.
예를 들어 다음은 테스트 스키마의 샘플 메시지입니다. 이 예시에서는 메시지 인코딩을
JSON
으로 선택합니다.{"ProductName":"GreenOnions", "SKU":34543, "InStock":true}
테스트 메시지 페이지를 종료합니다.
만들기를 클릭하여 스키마를 저장합니다.
gcloud
gcloud pubsub schemas create SCHEMA_ID \ --type=SCHEMA_TYPE \ --definition=SCHEMA_DEFINITION
각 항목의 의미는 다음과 같습니다.
- SCHEMA_TYPE은
avro
또는protocol-buffer
입니다. - SCHEMA_DEFINITION은 스키마 정의를 포함하는
string
으로, 선택한 스키마 유형에 따라 형식이 지정됩니다.
파일에서 스키마 정의를 지정할 수도 있습니다.
gcloud pubsub schemas create SCHEMA_ID \ --type=SCHEMA_TYPE \ --definition-file=SCHEMA_DEFINITION_FILE
각 항목의 의미는 다음과 같습니다.
- SCHEMA_TYPE은
avro
또는protocol-buffer
입니다. - SCHEMA_DEFINITION_FILE은 선택한 스키마 유형에 따라 형식이 지정된 스키마 정의가 있는 파일 경로가 포함되어 있는
string
입니다.
REST
스키마를 만들려면 다음과 같은 POST 요청을 전송하세요.
POST https://pubsub.googleapis.com/v1/projects/PROJECT_ID/schemas/SCHEMA_ID Authorization: Bearer $(gcloud auth application-default print-access-token) Content-Type: application/json --data @response-body.json
요청 본문에 다음 필드를 지정합니다.
{ "definition": SCHEMA_DEFINITION "type": SCHEMA_TYPE }
각 항목의 의미는 다음과 같습니다.
- SCHEMA_TYPE은
avro
또는protocol-buffer
입니다. - SCHEMA_DEFINITION은 스키마 정의를 포함하는 문자열로, 선택한 스키마 유형에 따라 형식이 지정됩니다.
응답 본문에는 스키마 리소스의 JSON 표현이 포함되어야 합니다. 예를 들면 다음과 같습니다.
{ "name": SCHEMA_NAME, "type": SCHEMA_TYPE, "definition": SCHEMA_DEFINITION "revisionId": REVISION_ID "revisionCreateTime": REVISION_CREATE_TIME }
각 항목의 의미는 다음과 같습니다.
- REVISION_ID는 해당 버전에 대한 서버 생성 ID입니다.
- REVISION_CREATE_TIME은 버전이 생성된 ISO 8601 타임스탬프입니다.
C++
이 샘플을 시도하기 전에 빠른 시작: 클라이언트 라이브러리 사용의 C++ 설정 안내를 따르세요. 자세한 내용은 Pub/Sub C++ API 참고 문서를 확인하세요.
Avro
Proto
C#
이 샘플을 시도하기 전에 빠른 시작: 클라이언트 라이브러리 사용의 C# 설정 안내를 따르세요. 자세한 내용은 Pub/Sub C# API 참고 문서를 확인하세요.
Avro
Proto
Go
이 샘플을 시도하기 전에 빠른 시작: 클라이언트 라이브러리 사용의 Go 설정 안내를 따르세요. 자세한 내용은 Pub/Sub Go API 참고 문서를 참조하세요.
Avro
Proto
자바
이 샘플을 시도하기 전에 빠른 시작: 클라이언트 라이브러리 사용의 Java 설정 안내를 따르세요. 자세한 내용은 Pub/Sub Java API 참고 문서를 참조하세요.
Avro
Proto
Node.js
이 샘플을 시도하기 전에 빠른 시작: 클라이언트 라이브러리 사용의 Node.js 설정 안내를 따르세요. 자세한 내용은 Pub/Sub Node.js API 참고 문서를 참조하세요.
Avro
Proto
Node.js
이 샘플을 시도하기 전에 빠른 시작: 클라이언트 라이브러리 사용의 Node.js 설정 안내를 따르세요. 자세한 내용은 Pub/Sub Node.js API 참고 문서를 참조하세요.
Avro
Proto
PHP
이 샘플을 시도하기 전에 빠른 시작: 클라이언트 라이브러리 사용의 PHP 설정 안내를 따르세요. 자세한 내용은 Pub/Sub PHP API 참고 문서를 참조하세요.
Avro
Proto
Python
이 샘플을 시도하기 전에 빠른 시작: 클라이언트 라이브러리 사용의 Python 설정 안내를 따르세요. 자세한 내용은 Pub/Sub Python API 참고 문서를 참조하세요.
Avro
Proto
Ruby
이 샘플을 시도하기 전에 빠른 시작: 클라이언트 라이브러리 사용의 Ruby 설정 안내를 따르세요. 자세한 내용은 Pub/Sub Ruby API 참고 문서를 참조하세요.
Avro
Proto
스키마가 생성된 다음에는 스키마 페이지에서 스키마 세부정보를 확인할 수 있습니다.
스키마를 주제와 연결할 수 있습니다.