Reference documentation and code samples for the Stackdriver Logging V2 Client class ListLogEntriesRequest.
The parameters to ListLogEntries
.
Generated from protobuf message google.logging.v2.ListLogEntriesRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ resource_names
array
Required. Names of one or more parent resources 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]
Projects listed in the project_ids
field are added to this list.
↳ filter
string
Optional. A filter that chooses which log entries to return. See Advanced Logs Queries
. 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 listed in resource_names
will cause the filter to return no results. The maximum length of the filter is 20000 characters.
↳ order_by
string
Optional. How the results should be sorted. Presently, the only permitted values are "timestamp asc"
(default) and "timestamp desc"
. The first option returns entries in order of increasing values of LogEntry.timestamp
(oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id
values.
↳ page_size
int
Optional. The maximum number of results to return from this request. Default is 50. If the value is negative or exceeds 1000, the request is rejected. The presence of next_page_token
in the response indicates that more results might be available.
↳ page_token
string
Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token
must be the value of next_page_token
from the previous response. The values of other method parameters should be identical to those in the previous call.
getResourceNames
Required. Names of one or more parent resources 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]
Projects listed in theproject_ids
field are added to this list.
-
Generated from protobuf field repeated string resource_names = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
Google\Protobuf\Internal\RepeatedField
setResourceNames
Required. Names of one or more parent resources 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]
Projects listed in theproject_ids
field are added to this list.
-
Generated from protobuf field repeated string resource_names = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
var
string[]
$this
getFilter
Optional. A filter that chooses which log entries to return. See Advanced Logs Queries .
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 listed in resource_names
will
cause the filter to return no results. The maximum length of the filter is
20000 characters.
Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
string
setFilter
Optional. A filter that chooses which log entries to return. See Advanced Logs Queries .
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 listed in resource_names
will
cause the filter to return no results. The maximum length of the filter is
20000 characters.
Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getOrderBy
Optional. How the results should be sorted. Presently, the only permitted
values are "timestamp asc"
(default) and "timestamp desc"
. The first
option returns entries in order of increasing values of LogEntry.timestamp
(oldest first), and the second option returns entries
in order of decreasing timestamps (newest first). Entries with equal
timestamps are returned in order of their insert_id
values.
Generated from protobuf field string order_by = 3 [(.google.api.field_behavior) = OPTIONAL];
string
setOrderBy
Optional. How the results should be sorted. Presently, the only permitted
values are "timestamp asc"
(default) and "timestamp desc"
. The first
option returns entries in order of increasing values of LogEntry.timestamp
(oldest first), and the second option returns entries
in order of decreasing timestamps (newest first). Entries with equal
timestamps are returned in order of their insert_id
values.
Generated from protobuf field string order_by = 3 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getPageSize
Optional. The maximum number of results to return from this request. Default is 50.
If the value is negative or exceeds 1000, the request is rejected. The
presence of next_page_token
in the response indicates that more results
might be available.
Generated from protobuf field int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];
int
setPageSize
Optional. The maximum number of results to return from this request. Default is 50.
If the value is negative or exceeds 1000, the request is rejected. The
presence of next_page_token
in the response indicates that more results
might be available.
Generated from protobuf field int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];
var
int
$this
getPageToken
Optional. If present, then retrieve the next batch of results from the
preceding call to this method. page_token
must be the value of next_page_token
from the previous response. The values of other method
parameters should be identical to those in the previous call.
Generated from protobuf field string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
string
setPageToken
Optional. If present, then retrieve the next batch of results from the
preceding call to this method. page_token
must be the value of next_page_token
from the previous response. The values of other method
parameters should be identical to those in the previous call.
Generated from protobuf field string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this