Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Chronicle V1 API - Class Google::Cloud::Chronicle::V1::LogTypeSchema (v1.1.0)

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

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#details_field_schema_alternatives

def details_field_schema_alternatives() -> ::Array<::Google::Cloud::Chronicle::V1::LogTypeSchema::DetailsFieldSchemaAlternative>

Returns

(::Array<::Google::Cloud::Chronicle::V1::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.

#details_field_schema_alternatives=

def details_field_schema_alternatives=(value) -> ::Array<::Google::Cloud::Chronicle::V1::LogTypeSchema::DetailsFieldSchemaAlternative>

Parameter

value (::Array<::Google::Cloud::Chronicle::V1::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.

Returns

(::Array<::Google::Cloud::Chronicle::V1::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.

#details_field_schemas

def details_field_schemas() -> ::Array<::Google::Cloud::Chronicle::V1::LogTypeSchema::DetailsFieldSchema>

Returns

(::Array<::Google::Cloud::Chronicle::V1::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_schemas=

def details_field_schemas=(value) -> ::Array<::Google::Cloud::Chronicle::V1::LogTypeSchema::DetailsFieldSchema>

Parameter

value (::Array<::Google::Cloud::Chronicle::V1::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.

Returns

(::Array<::Google::Cloud::Chronicle::V1::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.

#display_name

def display_name() -> ::String

Returns

(::String) — A human-readable name for this log type.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — A human-readable name for this log type.

Returns

(::String) — A human-readable name for this log type.

#log_type

def log_type() -> ::String

Returns

(::String) — The log type to be used in the details.log_type field.

#log_type=

def log_type=(value) -> ::String

Parameter

value (::String) — The log type to be used in the details.log_type field.

Returns

(::String) — The log type to be used in the details.log_type field.

#name

def name() -> ::String

Returns

(::String) — The resource name. Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type}"

#name=

def name=(value) -> ::String

Parameter

value (::String) — The resource name. Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type}"

Returns

(::String) — The resource name. Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type}"

#read_only

def read_only() -> ::Boolean

Returns

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

#read_only=

def read_only=(value) -> ::Boolean

Parameter

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

Returns

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

#supporting_documentation

def supporting_documentation() -> ::String

Returns

(::String) — A description that is displayed when users create or edit feeds.

#supporting_documentation=

def supporting_documentation=(value) -> ::String

Parameter

value (::String) — A description that is displayed when users create or edit feeds.

Returns

(::String) — A description that is displayed when users create or edit feeds.