com.oracle.bmc.apmsynthetics.requests

Class ListMonitorsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.apmsynthetics.requests.ListMonitorsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public class ListMonitorsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListMonitorsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListMonitorsRequest.Builder
static class	ListMonitorsRequest.SortBy The field to sort by.

Constructor Summary

Constructors

Constructor and Description
ListMonitorsRequest()

Method Summary

Modifier and Type	Method and Description
static ListMonitorsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getApmDomainId() The APM domain ID the request is intended for.
String	getDisplayName() A filter to return only the resources that match the entire display name.
Boolean	getIsMaintenanceWindowActive() A filter to return the monitors whose maintenance window is currently active.
Boolean	getIsMaintenanceWindowSet() A filter to return the monitors whose maintenance window is set.
Integer	getLimit() The maximum number of items to return.
String	getMonitorType() A filter to return only monitors that match the given monitor type.
String	getOpcRequestId() Unique identifier for the request.
String	getPage() The maximum number of results per page, or items to return in a paginated “List” call.
String	getScriptId() A filter to return only monitors using scriptId.
ListMonitorsRequest.SortBy	getSortBy() The field to sort by.
SortOrders	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
MonitorStatus	getStatus() A filter to return only monitors that match the status given.
String	getVantagePoint() The name of the public or dedicated vantage point.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListMonitorsRequest.Builder	toBuilder() Return an instance of ListMonitorsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListMonitorsRequest

public ListMonitorsRequest()

Method Detail

getApmDomainId

public String getApmDomainId()

The APM domain ID the request is intended for.

getDisplayName

public String getDisplayName()

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

getScriptId

public String getScriptId()

A filter to return only monitors using scriptId.

getVantagePoint

public String getVantagePoint()

The name of the public or dedicated vantage point.

getMonitorType

public String getMonitorType()

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.

getStatus

public MonitorStatus getStatus()

A filter to return only monitors that match the status given.

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

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

getIsMaintenanceWindowActive

public Boolean getIsMaintenanceWindowActive()

A filter to return the monitors whose maintenance window is currently active.

getIsMaintenanceWindowSet

public Boolean getIsMaintenanceWindowSet()

A filter to return the monitors whose maintenance window is set.

getSortOrder

public SortOrders getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC). Default sort order is ascending.

getSortBy

public ListMonitorsRequest.SortBy getSortBy()

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.

getOpcRequestId

public String getOpcRequestId()

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

toBuilder

public ListMonitorsRequest.Builder toBuilder()

Return an instance of ListMonitorsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListMonitorsRequest.Builder that allows you to modify request properties.

builder

public static ListMonitorsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>