com.oracle.bmc.apmsynthetics.requests

Class ListWorkersRequest.Builder

java.lang.Object

com.oracle.bmc.apmsynthetics.requests.ListWorkersRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListWorkersRequest,Void>

Enclosing class:

ListWorkersRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListWorkersRequest.Builder	apmDomainId(String apmDomainId) The APM domain ID the request is intended for.
ListWorkersRequest	build() Build the instance of ListWorkersRequest as configured by this builder
ListWorkersRequest	buildWithoutInvocationCallback() Build the instance of ListWorkersRequest as configured by this builder
ListWorkersRequest.Builder	capability(String capability) A filter to return only On-premise VP workers that match the capability given.
ListWorkersRequest.Builder	copy(ListWorkersRequest o) Copy method to populate the builder with values from the given instance.
ListWorkersRequest.Builder	displayName(String displayName) A filter to return only the resources that match the entire display name.
ListWorkersRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListWorkersRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListWorkersRequest.Builder	name(String name) A filter to return only the resources that match the entire name.
ListWorkersRequest.Builder	onPremiseVantagePointId(String onPremiseVantagePointId) The OCID of the On-premise vantage point.
ListWorkersRequest.Builder	opcRequestId(String opcRequestId) Unique identifier for the request.
ListWorkersRequest.Builder	page(String page) The maximum number of results per page, or items to return in a paginated “List” call.
ListWorkersRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListWorkersRequest.Builder	sortBy(ListWorkersRequest.SortBy sortBy) The field to sort by.
ListWorkersRequest.Builder	sortOrder(SortOrders sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).
ListWorkersRequest.Builder	status(OnPremiseVantagePointWorkerStatus status) A filter to return only On-premise VP workers that match the status given.

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 ListWorkersRequest.Builder apmDomainId(String apmDomainId)

The APM domain ID the request is intended for.

Parameters:

apmDomainId - the value to set

Returns:

this builder instance

onPremiseVantagePointId

public ListWorkersRequest.Builder onPremiseVantagePointId(String onPremiseVantagePointId)

The OCID of the On-premise vantage point.

Parameters:

onPremiseVantagePointId - the value to set

Returns:

this builder instance

limit

public ListWorkersRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListWorkersRequest.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

status

public ListWorkersRequest.Builder status(OnPremiseVantagePointWorkerStatus status)

A filter to return only On-premise VP workers that match the status given.

Parameters:

status - the value to set

Returns:

this builder instance

capability

public ListWorkersRequest.Builder capability(String capability)

A filter to return only On-premise VP workers that match the capability given.

Parameters:

capability - the value to set

Returns:

this builder instance

sortOrder

public ListWorkersRequest.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 ListWorkersRequest.Builder sortBy(ListWorkersRequest.SortBy sortBy)

The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated, timeUpdated and timeLastSyncup is descending. The displayName sort by is case-sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

displayName

public ListWorkersRequest.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

name

public ListWorkersRequest.Builder name(String name)

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

Parameters:

name - the value to set

Returns:

this builder instance

opcRequestId

public ListWorkersRequest.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 ListWorkersRequest.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 ListWorkersRequest.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 ListWorkersRequest.Builder copy(ListWorkersRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListWorkersRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListWorkersRequest build()

Build the instance of ListWorkersRequest 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<ListWorkersRequest,Void>

Returns:

instance of ListWorkersRequest

buildWithoutInvocationCallback

public ListWorkersRequest buildWithoutInvocationCallback()

Build the instance of ListWorkersRequest 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 ListWorkersRequest