REST Resource: projects.locations.instances.feedPacks

Resource: FeedPack

FeedPack is a logical container for related LogTypes for which feeds can be configured.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "icon": string,
  "categories": [
    string
  ],
  "packType": enum (PackType),
  "packLogTypes": [
    {
      object (PackLogType)
    }
  ],
  "hidden": boolean,
  "packDocumentation": string
}
Fields
name

string

Identifier. The resource name of the feed pack. Format: projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feedPack}
displayName

string

Output only. The display name of the feed pack.
description

string

Output only. The description of the feed pack.
icon

string (bytes format)

Output only. The icon image of the content pack in base64 in png format.

A base64-encoded string.
categories[]

string

Output only. Categories the featured content is associated with. In case of product feed packs, there will be only one category.
packType

enum (PackType)

Output only. Type of pack.
packLogTypes[]

object (PackLogType)

Output only. Log types featured in the pack.
hidden

boolean

Output only. Whether the feed pack should be displayed in the Feeds Page.
packDocumentation

string

Output only. Pack specific documentation in markdown format.

PackType

Type of feed pack. Feeds Page currently only lists PRODUCT_BASED packs.

Enums
PACK_TYPE_UNSPECIFIED Unspecified feed pack type.
PRODUCT_BASED Product based feed pack type.
USECASE_BASED Use case based feed pack type.
ONBOARDING Onboarding feed pack type.

PackLogType

PackLogtype is a log type featured in the feed pack.

JSON representation 
{
  "logType": string,
  "required": boolean,
  "hasDefaultParser": boolean,
  "recommendedSourceType": enum (FeedSourceType),
  "displayName": string,
  "configurationDocumentation": string,
  "additionalDocumentation": string
}
Fields
logType

string

Log Type featured in the feed pack. Format: projects/{project}/locations/{location}/instances/{instance}/logTypes/{logType}
required

boolean

Whether the logtype is required to deploy a feed pack.
hasDefaultParser

boolean

Whether a default(prebuilt) parser is available for the given log type.
recommendedSourceType

enum (FeedSourceType)

The recommended source type for the log type.
displayName

string

The display name of the log type.
configurationDocumentation

string

Documentation to define steps on how to configure a log type.
additionalDocumentation

string

Documentation to share any CTAs for more reference.

Methods

get

 Gets a feed pack.

list

 Lists Packs for which feeds can be configured.