Package com.google.logging.v2

Interface TailLogEntriesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TailLogEntriesRequest, TailLogEntriesRequest.Builder
public interface TailLogEntriesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    getBufferWindow()
    Optional.
    com.google.protobuf.DurationOrBuilder
    getBufferWindowOrBuilder()
    Optional.
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    String
    getResourceNames(int index)
    Required.
    com.google.protobuf.ByteString
    getResourceNamesBytes(int index)
    Required.
    int
    getResourceNamesCount()
    Required.
    List<String>
    getResourceNamesList()
    Required.
    boolean
    hasBufferWindow()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getResourceNamesList

      List<String> 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];
      Returns:
      A list containing the resourceNames.

    • getResourceNamesCount

      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];
      Returns:
      The count of resourceNames.

    • getResourceNames

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The resourceNames at the given index.

    • getResourceNamesBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resourceNames at the given index.

    • getFilter

      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:
      The filter.

    • getFilterBytes

      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];
      Returns:
      The bytes for filter.

    • hasBufferWindow

      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];
      Returns:
      Whether the bufferWindow field is set.

    • getBufferWindow

      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];
      Returns:
      The bufferWindow.

    • getBufferWindowOrBuilder

      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];