Package com.google.logging.v2

Class TailLogEntriesRequest

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

    • Field Detail

      • RESOURCE_NAMES_FIELD_NUMBER

        public static final int RESOURCE_NAMES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BUFFER_WINDOW_FIELD_NUMBER

        public static final int BUFFER_WINDOW_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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. 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]`
        repeated string resource_names = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getResourceNamesList in interface TailLogEntriesRequestOrBuilder
        Returns:
        A list containing the resourceNames.

      • getResourceNamesCount

        public int getResourceNamesCount()
         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]`
        repeated string resource_names = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getResourceNamesCount in interface TailLogEntriesRequestOrBuilder
        Returns:
        The count of resourceNames.

      • getResourceNames

        public String getResourceNames​(int index)
         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]`
        repeated string resource_names = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getResourceNames in interface TailLogEntriesRequestOrBuilder
        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. 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]`
        repeated string resource_names = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getResourceNamesBytes in interface TailLogEntriesRequestOrBuilder
        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 TailLogEntriesRequestOrBuilder
        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 TailLogEntriesRequestOrBuilder
        Returns:
        The bytes for filter.

      • hasBufferWindow

        public boolean hasBufferWindow()
         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.
        .google.protobuf.Duration buffer_window = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasBufferWindow in interface TailLogEntriesRequestOrBuilder
        Returns:
        Whether the bufferWindow field is set.

      • getBufferWindow

        public com.google.protobuf.Duration 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.
        .google.protobuf.Duration buffer_window = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBufferWindow in interface TailLogEntriesRequestOrBuilder
        Returns:
        The bufferWindow.

      • getBufferWindowOrBuilder

        public com.google.protobuf.DurationOrBuilder getBufferWindowOrBuilder()
         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.
        .google.protobuf.Duration buffer_window = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBufferWindowOrBuilder in interface TailLogEntriesRequestOrBuilder

      • 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 TailLogEntriesRequest parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<TailLogEntriesRequest> 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 TailLogEntriesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder