public interface ListLogEntriesRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getFilter()
public abstract String getFilter()
Optional. 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 a filter is
20,000 characters.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()
Optional. 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 a filter is
20,000 characters.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for filter. |
getOrderBy()
public abstract String 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.
string order_by = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The orderBy. |
getOrderByBytes()
public abstract ByteString getOrderByBytes()
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.
string order_by = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for orderBy. |
getPageSize()
public abstract int 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.
int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The pageSize. |
getPageToken()
public abstract String 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.
string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()
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.
string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pageToken. |
getResourceNames(int index)
public abstract String getResourceNames(int index)
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. A maximum of 100 resources may be specified in a single request.
repeated string resource_names = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The resourceNames at the given index. |
getResourceNamesBytes(int index)
public abstract ByteString getResourceNamesBytes(int index)
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. A maximum of 100 resources may be specified in a single request.
repeated string resource_names = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the resourceNames at the given index. |
getResourceNamesCount()
public abstract int getResourceNamesCount()
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. A maximum of 100 resources may be specified in a single request.
repeated string resource_names = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
int | The count of resourceNames. |
getResourceNamesList()
public abstract List<String> getResourceNamesList()
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. A maximum of 100 resources may be specified in a single request.
repeated string resource_names = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
List<String> | A list containing the resourceNames. |