Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListMonitoredResourceTypesRequest

example

Click here to see how to use ListMonitoredResourceTypesRequest.

Properties

compartmentId

compartmentId: string

The OCID of the tenancy for which monitored resource types should be listed.

Optional excludeFields

excludeFields: Array<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.

Optional fields

fields: Array<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.

MonitoredResourceType Id, name and compartment will be added by default.

Optional isExcludeSystemTypes

isExcludeSystemTypes: undefined | false | true

A filter to exclude system resource types. If set to true, system resource types will be excluded.

Optional limit

limit: undefined | number

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.

Optional metricNamespace

metricNamespace: undefined | string

A filter to return monitored resource types that has the matching namespace.

Optional name

name: undefined | string

A filter to return monitored resource types that match exactly with the resource type name given.

Optional opcRequestId

opcRequestId: undefined | string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Optional page

page: undefined | string

For list pagination. The value of the {@code opc-next-page} response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

The field to sort by. Only one sort order may be provided. Default order for 'timeUpdated' is descending. Default order for 'name' is ascending.

Optional sortOrder

sortOrder: model.SortOrder

The sort order to use, either ascending ({@code ASC}) or descending ({@code DESC}).

Optional status

status: model.ResourceTypeLifecycleState

A filter to return only resources that matches with lifecycleState given.