Class ListMonitorsRequest

Inheritance

object

ListMonitorsRequest

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

Assembly: OCI.DotNetSDK.Apmsynthetics.dll

Syntax

public class ListMonitorsRequest : IOciRequest

Examples

Click here to see an example of how to use ListMonitors 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

DisplayName

Declaration

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

Property Value

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

IsMaintenanceWindowActive

Declaration

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

Property Value

Type	Description
bool?	A filter to return the monitors whose maintenance window is currently active.

IsMaintenanceWindowSet

Declaration

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

Property Value

Type	Description
bool?	A filter to return the monitors whose maintenance window is set.

Limit

Declaration

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

Property Value

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

MonitorType

Declaration

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

Property Value

Type	Description
string	A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.

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.

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

ScriptId

Declaration

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

Property Value

Type	Description
string	A filter to return only monitors using scriptId.

SortBy

Declaration

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

Property Value

Type	Description
ListMonitorsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case insensitive.

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). Default sort order is ascending.

Status

Declaration

[HttpConverter(TargetEnum.Query, "status")]
public MonitorStatus? Status { get; set; }

Property Value

Type	Description
MonitorStatus?	A filter to return only monitors that match the status given.

VantagePoint

Declaration

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

Property Value

Type	Description
string	The name of the public or dedicated vantage point.

Implements

IOciRequest