Package com.oracle.bmc.apmsynthetics.requests

Class ListMonitorsRequest.Builder

java.lang.Object

com.oracle.bmc.apmsynthetics.requests.ListMonitorsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListMonitorsRequest,Void>

Enclosing class:

ListMonitorsRequest

public static class ListMonitorsRequest.Builder
extends Object
implements BmcRequest.Builder<ListMonitorsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListMonitorsRequest.Builder	apmDomainId(String apmDomainId)	The APM domain ID the request is intended for.
ListMonitorsRequest	build()	Build the instance of ListMonitorsRequest as configured by this builder
ListMonitorsRequest	buildWithoutInvocationCallback()	Build the instance of ListMonitorsRequest as configured by this builder
ListMonitorsRequest.Builder	copy(ListMonitorsRequest o)	Copy method to populate the builder with values from the given instance.
ListMonitorsRequest.Builder	displayName(String displayName)	A filter to return only the resources that match the entire display name.
ListMonitorsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListMonitorsRequest.Builder	isMaintenanceWindowActive(Boolean isMaintenanceWindowActive)	A filter to return the monitors whose maintenance window is currently active.
ListMonitorsRequest.Builder	isMaintenanceWindowSet(Boolean isMaintenanceWindowSet)	A filter to return the monitors whose maintenance window is set.
ListMonitorsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListMonitorsRequest.Builder	monitorType(String monitorType)	A filter to return only monitors that match the given monitor type.
ListMonitorsRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListMonitorsRequest.Builder	page(String page)	The maximum number of results per page, or items to return in a paginated “List” call.
ListMonitorsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListMonitorsRequest.Builder	scriptId(String scriptId)	A filter to return only monitors using scriptId.
ListMonitorsRequest.Builder	sortBy(ListMonitorsRequest.SortBy sortBy)	The field to sort by.
ListMonitorsRequest.Builder	sortOrder(SortOrders sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListMonitorsRequest.Builder	status(MonitorStatus status)	A filter to return only monitors that match the status given.
ListMonitorsRequest.Builder	vantagePoint(String vantagePoint)	The name of the public or dedicated vantage point.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

apmDomainId

public ListMonitorsRequest.Builder apmDomainId(String apmDomainId)

The APM domain ID the request is intended for.

Parameters:

apmDomainId - the value to set

Returns:

this builder instance

displayName

public ListMonitorsRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

scriptId

public ListMonitorsRequest.Builder scriptId(String scriptId)

A filter to return only monitors using scriptId.

Parameters:

scriptId - the value to set

Returns:

this builder instance

vantagePoint

public ListMonitorsRequest.Builder vantagePoint(String vantagePoint)

The name of the public or dedicated vantage point.

Parameters:

vantagePoint - the value to set

Returns:

this builder instance

monitorType

public ListMonitorsRequest.Builder monitorType(String monitorType)

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.

Parameters:

monitorType - the value to set

Returns:

this builder instance

status

public ListMonitorsRequest.Builder status(MonitorStatus status)

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

Parameters:

status - the value to set

Returns:

this builder instance

limit

public ListMonitorsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListMonitorsRequest.Builder page(String page)

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

Parameters:

page - the value to set

Returns:

this builder instance

isMaintenanceWindowActive

public ListMonitorsRequest.Builder isMaintenanceWindowActive(Boolean isMaintenanceWindowActive)

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

Parameters:

isMaintenanceWindowActive - the value to set

Returns:

this builder instance

isMaintenanceWindowSet

public ListMonitorsRequest.Builder isMaintenanceWindowSet(Boolean isMaintenanceWindowSet)

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

Parameters:

isMaintenanceWindowSet - the value to set

Returns:

this builder instance

sortOrder

public ListMonitorsRequest.Builder sortOrder(SortOrders sortOrder)

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

Default sort order is ascending.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListMonitorsRequest.Builder sortBy(ListMonitorsRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListMonitorsRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

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

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListMonitorsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListMonitorsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListMonitorsRequest.Builder copy(ListMonitorsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListMonitorsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListMonitorsRequest build()

Build the instance of ListMonitorsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListMonitorsRequest,Void>

Returns:

instance of ListMonitorsRequest

buildWithoutInvocationCallback

public ListMonitorsRequest buildWithoutInvocationCallback()

Build the instance of ListMonitorsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListMonitorsRequest