public final class ListLogEntriesRequest extends GeneratedMessageV3 implements ListLogEntriesRequestOrBuilder
The parameters to ListLogEntries.
Protobuf type google.logging.v2.ListLogEntriesRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
RESOURCE_NAMES_FIELD_NUMBER
public static final int RESOURCE_NAMES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListLogEntriesRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListLogEntriesRequest.Builder newBuilder()
Returns
newBuilder(ListLogEntriesRequest prototype)
public static ListLogEntriesRequest.Builder newBuilder(ListLogEntriesRequest prototype)
Parameter
Returns
public static ListLogEntriesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListLogEntriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListLogEntriesRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListLogEntriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListLogEntriesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListLogEntriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListLogEntriesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListLogEntriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListLogEntriesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListLogEntriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListLogEntriesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListLogEntriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListLogEntriesRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListLogEntriesRequest getDefaultInstanceForType()
Returns
getFilter()
public String 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.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
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.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
getOrderBy()
public 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];
| Type | Description |
| String | The orderBy.
|
getOrderByBytes()
public 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];
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];
| Type | Description |
| int | The pageSize.
|
getPageToken()
public 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];
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public 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];
getParserForType()
public Parser<ListLogEntriesRequest> getParserForType()
Returns
Overrides
getResourceNames(int index)
public 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]
organization/[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.
repeated string resource_names = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| 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 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]
organization/[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.
repeated string resource_names = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| 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 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]
organization/[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.
repeated string resource_names = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| int | The count of resourceNames.
|
getResourceNamesList()
public ProtocolStringList 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]
organization/[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.
repeated string resource_names = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListLogEntriesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListLogEntriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListLogEntriesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
