Class ListMonitoredResourceTypesRequest
Implements
Inherited Members
Namespace: Oci.StackmonitoringService.Requests
Assembly: OCI.DotNetSDK.Stackmonitoring.dll
Syntax
public class ListMonitoredResourceTypesRequest : IOciRequest
Examples
Click here to see an example of how to use ListMonitoredResourceTypes request.
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the tenancy for which monitored resource types should be listed. |
Remarks
Required
ExcludeFields
Declaration
[HttpConverter(TargetEnum.Query, "excludeFields", CollectionFormatType.Multi)]
public List<string> ExcludeFields { get; set; }
Property Value
Type | Description |
---|---|
List<string> | Partial response refers to an optimization technique offered by the RESTful web APIs, to return all the information except the fields requested to be excluded (excludeFields) by the client. In this mechanism, the client sends the exclude field names as the query parameters for an API to the server, and the server trims down the default response content by removing the fields that are not required by the client. The parameter controls which fields to exlude and to return and should be a query string parameter called "excludeFields" of an array type, provide the values as enums, and use collectionFormat. |
Fields
Declaration
[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<string> Fields { get; set; }
Property Value
Type | Description |
---|---|
List<string> | Partial response refers to an optimization technique offered
by the RESTful web APIs, to return only the information
(fields) required by the client. In this mechanism, the client
sends the required field names as the query parameters for
an API to the server, and the server trims down the default
response content by removing the fields that are not required
by the client. The parameter controls which fields to
return and should be a query string parameter called "fields" of
an array type, provide the values as enums, and use collectionFormat.
|
IsExcludeSystemTypes
Declaration
[HttpConverter(TargetEnum.Query, "isExcludeSystemTypes")]
public bool? IsExcludeSystemTypes { get; set; }
Property Value
Type | Description |
---|---|
bool? | A filter to exclude system resource types. If set to true, system resource types will be excluded. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. |
MetricNamespace
Declaration
[HttpConverter(TargetEnum.Query, "metricNamespace")]
public string MetricNamespace { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return monitored resource types that has the matching namespace. |
Name
Declaration
[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return monitored resource types that match exactly with the resource type name given. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type | Description |
---|---|
string | For list pagination. The value of the |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListMonitoredResourceTypesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListMonitoredResourceTypesRequest.SortByEnum? | The field to sort by. Only one sort order may be provided. Default order for 'timeUpdated' is descending. Default order for 'name' is ascending. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
SortOrder? | The sort order to use, either ascending ( |
Status
Declaration
[HttpConverter(TargetEnum.Query, "status")]
public ResourceTypeLifecycleState? Status { get; set; }
Property Value
Type | Description |
---|---|
ResourceTypeLifecycleState? | A filter to return only resources that matches with lifecycleState given. |