Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListFieldsRequest

example

Click here to see how to use ListFieldsRequest.

Properties

Optional filter

filter: undefined | string

filter

Optional isIncludeParser

isIncludeParser: undefined | false | true

isIncludeParser

Optional isMatchAll

isMatchAll: undefined | false | true

A flag indicating how to handle filtering when multiple filter criteria are specified. A value of true will always result in the most expansive list of items being returned. For example, if two field lists are supplies as filter criteria, a value of true will result in any item matching a field in either list being returned, while a value of false will result in a list of items which only have fields contained in both input lists.

Optional limit

limit: undefined | number

The maximum number of items to return.

namespaceName

namespaceName: string

The Logging Analytics namespace used for the request.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Optional parserIds

parserIds: undefined | string

A list of parser names used for filtering. Only fields used by the specified parsers will be returned.

Optional parserNames

parserNames: undefined | string

A list of parser names used for filtering. Only fields used by the specified parsers will be returned.

Optional parserType

parserType: ParserType

The parser type used for filtering. Only items with, or associated with, parsers of the specified type will be returned.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

The attribute used to sort the returned fields

Optional sortOrder

sortOrder: SortOrder

The sort order to use, either ascending ({@code ASC}) or descending ({@code DESC}).

Optional sourceIds

sourceIds: undefined | string

A list of source IDs used for filtering. Only fields used by the specified sources will be returned.

Optional sourceNames

sourceNames: undefined | string

A list of source names used for filtering. Only fields used by the specified sources will be returned.