Package com.oracle.bmc.apmsynthetics.requests

Class ListMonitorsRequest

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

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.65.0/apmsynthetics/ListMonitorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListMonitorsRequest.

    • 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.

      • builder

        public static ListMonitorsRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request 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>