Class ListLogAnalyticsEntitiesRequest

Inheritance

object

ListLogAnalyticsEntitiesRequest

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 ListLogAnalyticsEntitiesRequest : IOciRequest

Examples

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

Properties

CloudResourceId

Declaration

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

Property Value

Type	Description
string	A filter to return only log analytics entities whose cloudResourceId matches the cloudResourceId given.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The ID of the compartment in which to list resources.

Remarks

Required

CreationSourceDetails

Declaration

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

Property Value

Type	Description
string	A filter to return only log analytics entities whose auto-creation source details contains the specified string.

CreationSourceType

Declaration

[HttpConverter(TargetEnum.Query, "creationSourceType", CollectionFormatType.Multi)]
public List<CreationSourceType> CreationSourceType { get; set; }

Property Value

Type	Description
List<CreationSourceType>	A filter to return only those log analytics entities with the specified auto-creation source.

DefinedTagEquals

Declaration

[HttpConverter(TargetEnum.Query, "definedTagEquals", CollectionFormatType.Multi)]
public List<string> DefinedTagEquals { get; set; }

Property Value

Type

Description

List<string>

A list of tag filters to apply. Only entities with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

DefinedTagExists

Declaration

[HttpConverter(TargetEnum.Query, "definedTagExists", CollectionFormatType.Multi)]
public List<string> DefinedTagExists { get; set; }

Property Value

Type

Description

List<string>

A list of tag existence filters to apply. Only entities for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

EntityTypeName

Declaration

[HttpConverter(TargetEnum.Query, "entityTypeName", CollectionFormatType.Multi)]
public List<string> EntityTypeName { get; set; }

Property Value

Type	Description
List<string>	A filter to return only log analytics entities whose entityTypeName matches the entire log analytics entity type name of one of the entityTypeNames given in the list. The match is case-insensitive.

FreeformTagEquals

Declaration

[HttpConverter(TargetEnum.Query, "freeformTagEquals", CollectionFormatType.Multi)]
public List<string> FreeformTagEquals { get; set; }

Property Value

Type	Description
List<string>	A list of tag filters to apply. Only entities with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".

FreeformTagExists

Declaration

[HttpConverter(TargetEnum.Query, "freeformTagExists", CollectionFormatType.Multi)]
public List<string> FreeformTagExists { get; set; }

Property Value

Type	Description
List<string>	A list of tag existence filters to apply. Only entities for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".

Hostname

Declaration

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

Property Value

Type	Description
string	A filter to return only log analytics entities whose hostname matches the entire hostname given.

HostnameContains

Declaration

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

Property Value

Type	Description
string	A filter to return only log analytics entities whose hostname contains the substring given. The match is case-insensitive.

IsManagementAgentIdNull

Declaration

[HttpConverter(TargetEnum.Query, "isManagementAgentIdNull")]
public ListLogAnalyticsEntitiesRequest.IsManagementAgentIdNullEnum? IsManagementAgentIdNull { get; set; }

Property Value

Type	Description
ListLogAnalyticsEntitiesRequest.IsManagementAgentIdNullEnum?	A filter to return only those log analytics entities whose managementAgentId is null or is not null.

IsShowAssociatedSourcesCount

Declaration

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

Property Value

Type	Description
bool?	Option to return count of associated log sources for log analytics entity(s).

LifecycleDetailsContains

Declaration

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

Property Value

Type	Description
string	A filter to return only log analytics entities whose lifecycleDetails contains the specified string.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public EntityLifecycleStates? LifecycleState { get; set; }

Property Value

Type	Description
EntityLifecycleStates?	A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

Limit

Declaration

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

Property Value

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

MetadataEquals

Declaration

[HttpConverter(TargetEnum.Query, "metadataEquals", CollectionFormatType.Multi)]
public List<string> MetadataEquals { get; set; }

Property Value

Type	Description
List<string>	A filter to return only log analytics entities whose metadata name, value and type matches the specified string. Each item in the array has the format "{name}:{value}:{type}". All inputs are case-insensitive.

Name

Declaration

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

Property Value

Type	Description
string	A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive.

NameContains

Declaration

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

Property Value

Type	Description
string	A filter to return only log analytics entities whose name contains the name given. The match is case-insensitive.

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.

SortBy

Declaration

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

Property Value

Type	Description
ListLogAnalyticsEntitiesRequest.SortByEnum?	The field to sort entities by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for entity name is ascending. If no value is specified timeCreated is default.

SortOrder

Declaration

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

Property Value

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

SourceId

Declaration

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

Property Value

Type	Description
string	A filter to return only log analytics entities whose sourceId matches the sourceId given.

Implements

IOciRequest