Class ListSourcesRequest
Implements
Inherited Members
Namespace: Oci.LoganalyticsService.Requests
Assembly: OCI.DotNetSDK.Loganalytics.dll
Syntax
public class ListSourcesRequest : IOciRequest
Examples
Click here to see an example of how to use ListSources request.
Properties
Categories
Declaration
[HttpConverter(TargetEnum.Query, "categories")]
public string Categories { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A comma-separated list of categories used for filtering |
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
EntityType
Declaration
[HttpConverter(TargetEnum.Query, "entityType")]
public string EntityType { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A filter to return only sources associated with entities of the specified type. The match is case-insensitive. |
IsAutoAssociated
Declaration
[HttpConverter(TargetEnum.Query, "isAutoAssociated")]
public bool? IsAutoAssociated { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | An auto-associate flag used for filtering. Only sources which are marked for automatic association will be returned. |
IsSimplified
Declaration
[HttpConverter(TargetEnum.Query, "isSimplified")]
public bool? IsSimplified { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | A flag specifying whether or not to return all source information, or a subset of the information about each source. A value of true will return only the source unique identifier and the source name. A value of false will return all source information (such as author, updated date, system flag, etc.) |
IsSystem
Declaration
[HttpConverter(TargetEnum.Query, "isSystem")]
public ListSourcesRequest.IsSystemEnum? IsSystem { get; set; }
Property Value
| Type | Description |
|---|---|
| ListSourcesRequest.IsSystemEnum? | The system value used for filtering. Only items with the specified system value will be returned. Valid values are built in, custom (for user defined items), or all (for all items, regardless of system value). |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
| Type | Description |
|---|---|
| int? | The maximum number of items to return. |
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. |
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. |
PatternText
Declaration
[HttpConverter(TargetEnum.Query, "patternText")]
public string PatternText { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The pattern text filter. Only sources with a pattern | which contains text with the specified string will be returned. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListSourcesRequest.SortByEnum? SortBy { get; set; }
Property Value
| Type | Description |
|---|---|
| ListSourcesRequest.SortByEnum? | The attribute used to sort the returned sources |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListSourcesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
| Type | Description |
|---|---|
| ListSourcesRequest.SortOrderEnum? | The sort order to use, either ascending ( |
SourceDisplayText
Declaration
[HttpConverter(TargetEnum.Query, "sourceDisplayText")]
public string SourceDisplayText { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The source display text used for filtering. Only sources with the specified name or description will be returned. |
SourceType
Declaration
[HttpConverter(TargetEnum.Query, "sourceType")]
public string SourceType { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The source type. |