Package com.google.logging.v2

Class ListLogEntriesRequest

  • All Implemented Interfaces:
    ListLogEntriesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListLogEntriesRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListLogEntriesRequestOrBuilder
     The parameters to `ListLogEntries`.
    Protobuf type google.logging.v2.ListLogEntriesRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getResourceNamesList

        public com.google.protobuf.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]`
  * `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) = { ... }
        Specified by:
        getResourceNamesList in interface ListLogEntriesRequestOrBuilder
        Returns:
        A list containing the resourceNames.

      • 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]`
  * `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) = { ... }
        Specified by:
        getResourceNamesCount in interface ListLogEntriesRequestOrBuilder
        Returns:
        The count of resourceNames.

      • getResourceNames

        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]`
  * `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) = { ... }
        Specified by:
        getResourceNames in interface ListLogEntriesRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The resourceNames at the given index.

      • getResourceNamesBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getResourceNamesBytes in interface ListLogEntriesRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the resourceNames at the given index.

      • getFilter

        public 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];
        Specified by:
        getFilter in interface ListLogEntriesRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.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];
        Specified by:
        getFilterBytes in interface ListLogEntriesRequestOrBuilder
        Returns:
        The bytes for filter.

      • 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];
        Specified by:
        getOrderBy in interface ListLogEntriesRequestOrBuilder
        Returns:
        The orderBy.

      • getOrderByBytes

        public com.google.protobuf.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];
        Specified by:
        getOrderByBytes in interface ListLogEntriesRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • getPageSize

        public 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];
        Specified by:
        getPageSize in interface ListLogEntriesRequestOrBuilder
        Returns:
        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];
        Specified by:
        getPageToken in interface ListLogEntriesRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.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];
        Specified by:
        getPageTokenBytes in interface ListLogEntriesRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ListLogEntriesRequest parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListLogEntriesRequest parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListLogEntriesRequest parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListLogEntriesRequest parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListLogEntriesRequest parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListLogEntriesRequest parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public ListLogEntriesRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ListLogEntriesRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ListLogEntriesRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListLogEntriesRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ListLogEntriesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder