Method: ingestionLogLabels.list

Full name: projects.locations.instances.ingestionLogLabels.list

Returns the ingestion log labels for the customer.

HTTP request

GET https://chronicle.googleapis.com/v1alpha/{parent}/ingestionLogLabels

Path parameters

Parameters
parent

string

Required. The parent resource owning the ingestion labels Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
filter

string

Optional. Filter uses AIP-160 expression syntax, where only key and banned fields can be used in filter expression, following are example filters * filter banned = true to get banned labels * filter key = <query> to get labels with specified key * empty filter returns all labels filter complexity is limited to simpler expressions as mentioned above with some OR or AND expressions.

view

enum (LabelView)

Optional. concerned fields from ingestion log label

pageSize

integer

Optional. The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 100 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

Optional. A page token, received from a previous ListIngestionLogLabels call. Provide this to retrieve the subsequent page. All fields (except page_size) need to match the previous call. In particular, filter and view need to match.

Request body

The request body must be empty.

Response body

Response message for ListIngestionLogLabels

If successful, the response body contains data with the following structure:

JSON representation
{
  "ingestion_log_labels": [
    {
      object (IngestionLogLabel)
    }
  ],
  "next_page_token": string
}
Fields
ingestion_log_labels[]

object (IngestionLogLabel)

Holds the ingestion log labels for the customer.

next_page_token

string

Optional. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.ingestionLogLabels.list

For more information, see the IAM documentation.

LabelView

Fields from ingestion log label.

Enums
LABEL_VIEW_UNSPECIFIED Populate all fields if no view is specified.
LABEL_VIEW_KEY Populate keys field.
LABEL_VIEW_VALUE Populate values field.
LABEL_VIEW_FULL Populate all fields.