Reference documentation and code samples for the Stackdriver Logging V2 Client class TailLogEntriesRequest.
The parameters to TailLogEntries.
Generated from protobuf message google.logging.v2.TailLogEntriesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ resource_names |
array
Required. Name of a parent resource from which to retrieve log entries: * |
↳ filter |
string
Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in |
↳ buffer_window |
Google\Protobuf\Duration
Optional. The amount of time to buffer log entries at the server before being returned to prevent out of order results due to late arriving log entries. Valid values are between 0-60000 milliseconds. Defaults to 2000 milliseconds. |
getResourceNames
Required. Name of a parent resource from which to retrieve log entries:
projects/[PROJECT_ID]organizations/[ORGANIZATION_ID]billingAccounts/[BILLING_ACCOUNT_ID]folders/[FOLDER_ID]May alternatively be one or more views:projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setResourceNames
Required. Name of a parent resource from which to retrieve log entries:
projects/[PROJECT_ID]organizations/[ORGANIZATION_ID]billingAccounts/[BILLING_ACCOUNT_ID]folders/[FOLDER_ID]May alternatively be one or more views:projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Optional. A filter that chooses which log entries to return. See Advanced Logs Filters.
Only log entries that match the filter are returned. An empty filter
matches all log entries in the resources listed in resource_names.
Referencing a parent resource that is not in resource_names will cause
the filter to return no results. The maximum length of the filter is 20000
characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Optional. A filter that chooses which log entries to return. See Advanced Logs Filters.
Only log entries that match the filter are returned. An empty filter
matches all log entries in the resources listed in resource_names.
Referencing a parent resource that is not in resource_names will cause
the filter to return no results. The maximum length of the filter is 20000
characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBufferWindow
Optional. The amount of time to buffer log entries at the server before being returned to prevent out of order results due to late arriving log entries. Valid values are between 0-60000 milliseconds. Defaults to 2000 milliseconds.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasBufferWindow
clearBufferWindow
setBufferWindow
Optional. The amount of time to buffer log entries at the server before being returned to prevent out of order results due to late arriving log entries. Valid values are between 0-60000 milliseconds. Defaults to 2000 milliseconds.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |