Method: logTypeSchemas.list

Full name: projects.locations.instances.feedSourceTypeSchemas.logTypeSchemas.list

List all LogTypeSchemas compatible with a given FeedSourceType.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/logTypeSchemas

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of LogTypeSchemas. Format: Format: projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feedSourceType}

Query parameters

Parameters
pageSize

integer

The maximum number of LogTypeSchemas to return. The service may return fewer than this value. If unspecified, at most 5000 LogTypeSchemas will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
pageToken

string

A page token, received from a previous logTypeSchemas.list call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

logTypeSchemas.list response message.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "logTypeSchemas": [
    {
      object (LogTypeSchema)
    }
  ],
  "nextPageToken": string
}
Fields
logTypeSchemas[]

object (LogTypeSchema)

LogTypeSchemas.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.logTypeSchemas.list

For more information, see the IAM documentation.

LogTypeSchema

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

JSON representation 
{
  "name": string,
  "displayName": string,
  "logType": string,
  "readOnly": boolean,
  "supportingDocumentation": string,
  "detailsFieldSchemas": [
    {
      object (DetailsFieldSchema)
    }
  ],
  "detailsFieldSchemaAlternatives": [
    {
      object (DetailsFieldSchemaAlternative)
    }
  ]
}
Fields
name

string

The resource name. Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feedSourceType}/logTypeSchemas/{logType}"
displayName

string

A human-readable name for this log type.
logType

string

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

boolean

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

string

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

object (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 detailsFieldSchemaAlternatives.
detailsFieldSchemaAlternatives[]

object (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.

DetailsFieldSchema

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

JSON representation 
{
  "fieldPath": string,
  "displayName": string,
  "description": string,
  "type": enum (SemanticType),
  "enumFieldSchemas": [
    {
      object (EnumFieldSchema)
    }
  ],
  "required": boolean,
  "exampleInput": string,
  "readOnly": boolean
}
Fields
fieldPath

string

The protocol buffer field path. For example, "details.azure_ad_context_settings.authentication.token_endpoint".
displayName

string

A human-readable name for this field.
description

string

A human-readable description for this field.
type

enum (SemanticType)

A type that represents both the encoding and the semantics of this field.
enumFieldSchemas[]

object (EnumFieldSchema)

If a field has an enum type, this is the schema describing the possible values.
required

boolean

Whether this field must be specified to have a valid feed configuration.
exampleInput

string

For those fields with input requirements that aren't adequately expressed by the SemanticType it is often useful to supply an example input.
readOnly

boolean

For those fields which are read only.

SemanticType

An enumeration of the possible types of a Feed.details field, where type implies both encoding and semantics. This is used in constructing a schema in order to construct a UI for creating well formed feeds.

Enums
SEMANTIC_TYPE_UNSPECIFIED No semantic type. All fields must specify a semantic type.
BOOL A boolean (with no special semantics).
ENUM An enum (with no special semantics).
KEY_VALUE_LIST A repeated field with a Message type where the Message contains two fields: key and value.
MAP_STRING_STRING A map<string, string> (with no special semantics).
STRING A string (with no special semantics).
STRING_LIST A repeated string (with no special semantics).
STRING_MULTILINE A string that may contain any whitespace characters (with no special semantics).
STRING_MULTILINE_SECRET A string that may contain any whitespace characters and that encodes a secret.
STRING_SECRET A string which encodes a secret.
STRING_URI A string which encodes a URI.
STRING_URI_LIST A repeated string which encodes URIs.

EnumFieldSchema

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

JSON representation 
{
  "value": string,
  "displayName": string,
  "description": string
}
Fields
value

string

The value to assign to the field.
displayName

string

A human-readable name for this value.
description

string

A human-readable description for this value.

DetailsFieldSchemaAlternative

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

JSON representation 
{
  "detailsFieldSchemaSets": [
    {
      object (DetailsFieldSchemaSet)
    }
  ]
}
Fields
detailsFieldSchemaSets[]

object (DetailsFieldSchemaSet)

The schemas for each alternative set of fields.

DetailsFieldSchemaSet

A collection of schemas for related fields within details.

JSON representation 
{
  "displayName": string,
  "description": string,
  "detailsFieldSchemas": [
    {
      object (DetailsFieldSchema)
    }
  ]
}
Fields
displayName

string

A human-readable name for this collection of details fields.
description

string

A human-readable description for this collection of details fields.
detailsFieldSchemas[]

object (DetailsFieldSchema)

Schemas for the fields in this set.