Google Cloud Chronicle V1 Client - Class LogTypeSchema (0.7.1)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class LogTypeSchema.

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

Generated from protobuf message google.cloud.chronicle.v1.LogTypeSchema

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The resource name. Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type}"
`↳ display_name`	`string` A human-readable name for this log type.
`↳ log_type`	`string` 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`	`string` A description that is displayed when users create or edit feeds.
`↳ details_field_schemas`	`array<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`	`array<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.

getName

The resource name.

Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type}"

Returns
Type	Description
`string`

setName

The resource name.

Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type}"

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

A human-readable name for this log type.

Returns
Type	Description
`string`

setDisplayName

A human-readable name for this log type.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLogType

The log type to be used in the details.log_type field.

Returns
Type	Description
`string`

setLogType

The log type to be used in the details.log_type field.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReadOnly

Whether this log type schema represents a feed configuration that may exist, but should not be modified (created, edited, or deleted).

Returns
Type	Description
`bool`

setReadOnly

Whether this log type schema represents a feed configuration that may exist, but should not be modified (created, edited, or deleted).

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSupportingDocumentation

A description that is displayed when users create or edit feeds.

Returns
Type	Description
`string`

setSupportingDocumentation