Reference documentation and code samples for the Google Cloud Chronicle V1 Client class PackLogType.
PackLogtype is a log type featured in the feed pack.
Generated from protobuf message google.cloud.chronicle.v1.PackLogType
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ log_type |
string
Log Type featured in the feed pack. Format: projects/{project}/locations/{location}/instances/{instance}/logTypes/{log_type} |
↳ required |
bool
Whether the logtype is required to deploy a feed pack. |
↳ has_default_parser |
bool
Whether a default(prebuilt) parser is available for the given log type. |
↳ recommended_source_type |
int
The recommended source type for the log type. |
↳ display_name |
string
The display name of the log type. |
↳ configuration_documentation |
string
Documentation to define steps on how to configure a log type. |
↳ additional_documentation |
string
Documentation to share any CTAs for more reference. |
getLogType
Log Type featured in the feed pack.
Format: projects/{project}/locations/{location}/instances/{instance}/logTypes/{log_type}
| Returns | |
|---|---|
| Type | Description |
string |
|
setLogType
Log Type featured in the feed pack.
Format: projects/{project}/locations/{location}/instances/{instance}/logTypes/{log_type}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequired
Whether the logtype is required to deploy a feed pack.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRequired
Whether the logtype is required to deploy a feed pack.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHasDefaultParser
Whether a default(prebuilt) parser is available for the given log type.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setHasDefaultParser
Whether a default(prebuilt) parser is available for the given log type.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRecommendedSourceType
The recommended source type for the log type.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type FeedSourceType. |
setRecommendedSourceType
The recommended source type for the log type.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type FeedSourceType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
The display name of the log type.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
The display name of the log type.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConfigurationDocumentation
Documentation to define steps on how to configure a log type.
| Returns | |
|---|---|
| Type | Description |
string |
|
setConfigurationDocumentation
Documentation to define steps on how to configure a log type.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdditionalDocumentation
Documentation to share any CTAs for more reference.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAdditionalDocumentation
Documentation to share any CTAs for more reference.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|