Google Cloud Chronicle V1 Client - Class FeedPack (0.7.1)

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

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

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The resource name of the feed pack. Format: projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}
`↳ display_name`	`string` Output only. The display name of the feed pack.
`↳ description`	`string` Output only. The description of the feed pack.
`↳ icon`	`string` Output only. The icon image of the content pack in base64 in png format.
`↳ categories`	`string[]` Output only. Categories the featured content is associated with. In case of product feed packs, there will be only one category.
`↳ pack_type`	`int` Output only. Type of pack.
`↳ pack_log_types`	`array<PackLogType>` Output only. Log types featured in the pack.
`↳ hidden`	`bool` Output only. Whether the feed pack should be displayed in the Feeds Page.
`↳ pack_documentation`	`string` Output only. Pack specific documentation in markdown format.

getName

Identifier. The resource name of the feed pack.

Format: projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}

Returns
Type	Description
`string`

setName

Identifier. The resource name of the feed pack.

Format: projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Output only. The display name of the feed pack.

Returns
Type	Description
`string`

setDisplayName

Output only. The display name of the feed pack.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Output only. The description of the feed pack.

Returns
Type	Description
`string`

setDescription

Output only. The description of the feed pack.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIcon

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

Returns
Type	Description
`string`

setIcon

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCategories

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

Returns
Type	Description
`Google\Protobuf\RepeatedField<string>`

setCategories

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

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getPackType

Output only. Type of pack.

Returns
Type	Description
`int`	Enum of type PackType.

setPackType