Class ListConfigsRequest

Inheritance

object

ListConfigsRequest

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.ApmconfigService.Requests

Assembly: OCI.DotNetSDK.Apmconfig.dll

Syntax

public class ListConfigsRequest : IOciRequest

Examples

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

Properties

ApmDomainId

Declaration

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

Property Value

Type	Description
string	The APM Domain ID the request is intended for.

Remarks

Required

ConfigType

Declaration

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

Property Value

Type	Description
string	A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

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 resources 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 resources 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".

DisplayName

Declaration

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

Property Value

Type	Description
string	A filter to return resources that match the given display name.

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 resources 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 resources 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".

Limit

Declaration

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

Property Value

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

OpcRequestId

Declaration

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

Property Value

Type	Description
string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

OptionsGroup

Declaration

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

Property Value

Type	Description
string	A filter to return OPTIONS resources that match the given group.

Page

Declaration

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

Property Value

Type	Description
string	The maximum number of results per page, or items to return in a paginated "List" call. For information on how pagination works, see List Pagination. Example: 50

SortBy

Declaration

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

Property Value

Type	Description
ListConfigsRequest.SortByEnum?	The field to sort by. You can provide one "sortBy" value. The default order for displayName, timeCreated and timeUpdated is ascending. The displayName sort by is case-sensitive.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrders?	The sort order to use, either ascending (ASC) or descending (DESC). The displayName sort order is case-sensitive.

Implements

IOciRequest