Google Cloud Logging v2 API - Class ListLogEntriesRequest (4.4.0) 

public sealed class ListLogEntriesRequest : IMessage<ListLogEntriesRequest>, IEquatable<ListLogEntriesRequest>, IDeepCloneable<ListLogEntriesRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Google Cloud Logging v2 API class ListLogEntriesRequest.

The parameters to ListLogEntries.

Inheritance

object > ListLogEntriesRequest

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

ListLogEntriesRequest()

public ListLogEntriesRequest()

ListLogEntriesRequest(ListLogEntriesRequest)

public ListLogEntriesRequest(ListLogEntriesRequest other)
Parameter
Name Description
other ListLogEntriesRequest

Properties

Filter

public string Filter { get; set; }

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.

Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

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.

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

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.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type Description
string

ResourceNames

public RepeatedField<string> ResourceNames { get; }

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.

Property Value
Type Description
RepeatedFieldstring

ResourceNamesAsBillingAccountNames

public ResourceNameList<BillingAccountName> ResourceNamesAsBillingAccountNames { get; }

BillingAccountName-typed view over the ResourceNames resource name property.

Property Value
Type Description
ResourceNameListBillingAccountName

ResourceNamesAsFolderNames

public ResourceNameList<FolderName> ResourceNamesAsFolderNames { get; }

FolderName-typed view over the ResourceNames resource name property.

Property Value
Type Description
ResourceNameListFolderName

ResourceNamesAsOrganizationNames

public ResourceNameList<OrganizationName> ResourceNamesAsOrganizationNames { get; }

OrganizationName-typed view over the ResourceNames resource name property.

Property Value
Type Description
ResourceNameListOrganizationName

ResourceNamesAsProjectNames

public ResourceNameList<ProjectName> ResourceNamesAsProjectNames { get; }

ProjectName-typed view over the ResourceNames resource name property.

Property Value
Type Description
ResourceNameListProjectName

ResourceNamesAsResourceNames

public ResourceNameList<IResourceName> ResourceNamesAsResourceNames { get; }

IResourceName-typed view over the ResourceNames resource name property.

Property Value
Type Description
ResourceNameListIResourceName