Class LogTypeSchema (0.6.4)

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

Metadata that pertains to a log type in the context of Feeds, and is useful for building interfaces to construct valid Feed messages.

Attributes

Name Description
name str
The resource name. Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type}".
display_name str
A human-readable name for this log type.
log_type str
The log type to be used in the details.log_type field.
read_only bool
Whether this log type schema represents a feed configuration that may exist, but should not be modified (created, edited, or deleted).
supporting_documentation str
A description that is displayed when users create or edit feeds.
details_field_schemas MutableSequence[google.cloud.chronicle_v1.types.LogTypeSchema.DetailsFieldSchema]
The schemas for detail fields that are compatible with this log type and feed source type. All fields for this log type and feed source type are either contained here or within details_field_schema_alternatives.
details_field_schema_alternatives MutableSequence[google.cloud.chronicle_v1.types.LogTypeSchema.DetailsFieldSchemaAlternative]
There are sets of fields which represent alternatives to one another. A user would only fill in one set of fields for any one alternative.

Classes

DetailsFieldSchema

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

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

DetailsFieldSchemaAlternative

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

A collection of details field schema sets. The user must provide values for only one set of fields within an alternative.

DetailsFieldSchemaSet

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

A collection of schemas for related fields within details.

EnumFieldSchema

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

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