protobuf_descriptors
Protocol buffer definition for protobuf_descriptors
sift/protobuf_descriptors/v2/protobuf_descriptors.proto
AddProtobufDescriptorRequest
| Field | Type | Label | Description |
|---|---|---|---|
| protobuf_descriptor | ProtobufDescriptor | ||
| force_duplicate_registration | bool | If set to true, the service will ignore checks that this descriptor has already been registered and will ensure that it is registered as the latest proto descriptor for the message type. |
AddProtobufDescriptorResponse
| Field | Type | Label | Description |
|---|---|---|---|
| protobuf_descriptor | ProtobufDescriptor |
DeleteProtobufDescriptorsRequest
| Field | Type | Label | Description |
|---|---|---|---|
| message_type_full_name | string | Deprecated. | |
| namespace | string | Deprecated. | |
| organization_id | string | ||
| protobuf_descriptor_id | string |
DeleteProtobufDescriptorsResponse
ListProtobufDescriptorsRequest
The request for a call to ProtobufDescriptorService_ListProtobufDescriptors to retrieve protobuf descriptors.
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of protobuf descriptors to return. The service may return fewer than this value. If unspecified, at most 50 protobuf descriptors will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListProtobufDescriptors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProtobufDescriptors must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are protobuf_descriptor_id, proto_file_name, namespace, and message_type_full_name. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
| order_by | string | How to order the retrieved protobuf descriptors. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date, modified_date, and message_type_full_name and namespace. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date" |
ListProtobufDescriptorsResponse
The response of a call to ProtobufDescriptorService_ListProtobufDescriptors.
| Field | Type | Label | Description |
|---|---|---|---|
| protobuf_descriptors | ProtobufDescriptor | repeated | |
| next_page_token | string |
ProtobufDescriptor
| Field | Type | Label | Description |
|---|---|---|---|
| message_type_full_name | string | ||
| file_descriptor_set | bytes | ||
| proto_file_name | string | ||
| namespace | string | ||
| protobuf_descriptor_id | string |
ProtobufDescriptorService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| AddProtobufDescriptor | AddProtobufDescriptorRequest | AddProtobufDescriptorResponse | Used to register a protobuf message to be ingested. |
| DeleteProtobufDescriptors | DeleteProtobufDescriptorsRequest | DeleteProtobufDescriptorsResponse | Delete protobuf descriptors of that match the provided namespace and message_type_full_name. |
| ListProtobufDescriptors | ListProtobufDescriptorsRequest | ListProtobufDescriptorsResponse | Retrieve protobuf descriptors using an optional filter. |