Class DetailsFieldSchema (0.6.4)

DetailsFieldSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A schema for a particular details field on the Feed proto message.

Attributes

Name Description
field_path str
The protocol buffer field path. For example, "details.azure_ad_context_settings.authentication.token_endpoint".
display_name str
A human-readable name for this field.
description str
A human-readable description for this field.
type_ google.cloud.chronicle_v1.types.SemanticType
A type that represents both the encoding and the semantics of this field.
enum_field_schemas MutableSequence[google.cloud.chronicle_v1.types.LogTypeSchema.EnumFieldSchema]
If a field has an enum type, this is the schema describing the possible values.
required bool
Whether this field must be specified to have a valid feed configuration.
example_input str
For those fields with input requirements that aren't adequately expressed by the SemanticType it is often useful to supply an example input.
read_only bool
For those fields which are read only.