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

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

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — A human-readable description for this field.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — A human-readable description for this field.
Returns
  • (::String) — A human-readable description for this field.

#display_name

def display_name() -> ::String
Returns
  • (::String) — A human-readable name for this field.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — A human-readable name for this field.
Returns
  • (::String) — A human-readable name for this field.

#enum_field_schemas

def enum_field_schemas() -> ::Array<::Google::Cloud::Chronicle::V1::LogTypeSchema::EnumFieldSchema>
Returns

#enum_field_schemas=

def enum_field_schemas=(value) -> ::Array<::Google::Cloud::Chronicle::V1::LogTypeSchema::EnumFieldSchema>
Parameter
Returns

#example_input

def example_input() -> ::String
Returns
  • (::String) — For those fields with input requirements that aren't adequately expressed by the SemanticType it is often useful to supply an example input.

#example_input=

def example_input=(value) -> ::String
Parameter
  • value (::String) — For those fields with input requirements that aren't adequately expressed by the SemanticType it is often useful to supply an example input.
Returns
  • (::String) — For those fields with input requirements that aren't adequately expressed by the SemanticType it is often useful to supply an example input.

#field_path

def field_path() -> ::String
Returns
  • (::String) — The protocol buffer field path. For example, "details.azure_ad_context_settings.authentication.token_endpoint".

#field_path=

def field_path=(value) -> ::String
Parameter
  • value (::String) — The protocol buffer field path. For example, "details.azure_ad_context_settings.authentication.token_endpoint".
Returns
  • (::String) — The protocol buffer field path. For example, "details.azure_ad_context_settings.authentication.token_endpoint".

#read_only

def read_only() -> ::Boolean
Returns
  • (::Boolean) — For those fields which are read only.

#read_only=

def read_only=(value) -> ::Boolean
Parameter
  • value (::Boolean) — For those fields which are read only.
Returns
  • (::Boolean) — For those fields which are read only.

#required

def required() -> ::Boolean
Returns
  • (::Boolean) — Whether this field must be specified to have a valid feed configuration.

#required=

def required=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether this field must be specified to have a valid feed configuration.
Returns
  • (::Boolean) — Whether this field must be specified to have a valid feed configuration.

#type

def type() -> ::Google::Cloud::Chronicle::V1::SemanticType
Returns

#type=

def type=(value) -> ::Google::Cloud::Chronicle::V1::SemanticType
Parameter
Returns