Console
    Contact Us Start free

    Stackdriver Logging V2 Client - Class ListLogEntriesRequest (1.31.3)

    Reference documentation and code samples for the Stackdriver Logging V2 Client class ListLogEntriesRequest.

    The parameters to ListLogEntries .

    Generated from protobuf message google.logging.v2.ListLogEntriesRequest

    Namespace

    Google \ Cloud \ Logging \ V2

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ resource_names
    array

    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.

    ↳ filter
    string

    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.

    ↳ order_by
    string

    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.

    ↳ page_size
    int

    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.

    ↳ page_token
    string

    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.

    getResourceNames

    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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setResourceNames

    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.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setFilter

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setOrderBy

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    int

    setPageSize

    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.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setPageToken

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    static::build

    Parameters
    Name
    Description
    resourceNames
    string[]

    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. Please see LoggingServiceV2Client::projectName() for help formatting this field.

    filter
    string

    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.

    orderBy
    string

    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.

    Returns
    Type
    Description
    ListLogEntriesRequest
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: