Class ListFieldsRequest

Inheritance

object

ListFieldsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.LoganalyticsService.Requests

Assembly: OCI.DotNetSDK.Loganalytics.dll

Syntax

public class ListFieldsRequest : IOciRequest

Examples

Click here to see an example of how to use ListFields request.

Properties

Filter

Declaration

[HttpConverter(TargetEnum.Query, "filter")]
public string Filter { get; set; }

Property Value

Type	Description
string	filter

IsIncludeParser

Declaration

[HttpConverter(TargetEnum.Query, "isIncludeParser")]
public bool? IsIncludeParser { get; set; }

Property Value

Type	Description
bool?	isIncludeParser

IsMatchAll

Declaration

[HttpConverter(TargetEnum.Query, "isMatchAll")]
public bool? IsMatchAll { get; set; }

Property Value

Type	Description
bool?	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.

Type

Description

bool?

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.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The maximum number of items to return.

NamespaceName

Declaration

[Required(ErrorMessage = "NamespaceName is required.")]
[HttpConverter(TargetEnum.Path, "namespaceName")]
public string NamespaceName { get; set; }

Property Value

Type	Description
string	The Logging Analytics namespace used for the request.

Remarks

Required

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

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

ParserIds

Declaration

[HttpConverter(TargetEnum.Query, "parserIds")]
public string ParserIds { get; set; }

Property Value

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

ParserNames

Declaration

[HttpConverter(TargetEnum.Query, "parserNames")]
public string ParserNames { get; set; }

Property Value

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

ParserType

Declaration

[HttpConverter(TargetEnum.Query, "parserType")]
public ListFieldsRequest.ParserTypeEnum? ParserType { get; set; }

Property Value

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

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListFieldsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListFieldsRequest.SortByEnum?	The attribute used to sort the returned fields

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListFieldsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListFieldsRequest.SortOrderEnum?	The sort order to use, either ascending (`ASC`) or descending (`DESC`).

SourceIds

Declaration

[HttpConverter(TargetEnum.Query, "sourceIds")]
public string SourceIds { get; set; }

Property Value

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

SourceNames

Declaration

[HttpConverter(TargetEnum.Query, "sourceNames")]
public string SourceNames { get; set; }

Property Value

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

Implements

IOciRequest