Package com.oracle.bmc.iot.requests

Class ListIotDomainsRequest.Builder

java.lang.Object

com.oracle.bmc.iot.requests.ListIotDomainsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListIotDomainsRequest,Void>

Enclosing class:

ListIotDomainsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListIotDomainsRequest	build()	Build the instance of ListIotDomainsRequest as configured by this builder
ListIotDomainsRequest	buildWithoutInvocationCallback()	Build the instance of ListIotDomainsRequest as configured by this builder
ListIotDomainsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment in which to list resources.
ListIotDomainsRequest.Builder	copy(ListIotDomainsRequest o)	Copy method to populate the builder with values from the given instance.
ListIotDomainsRequest.Builder	displayName(String displayName)	Filter resources whose display name matches the specified value.
ListIotDomainsRequest.Builder	id(String id)	Filter resources by OCID.
ListIotDomainsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListIotDomainsRequest.Builder	iotDomainGroupId(String iotDomainGroupId)	Filter resources that match the specified OCID of the IoT domain group.
ListIotDomainsRequest.Builder	lifecycleState(IotDomain.LifecycleState lifecycleState)	Filter resources whose lifecycleState matches the specified value.
ListIotDomainsRequest.Builder	limit(Integer limit)	For list pagination.
ListIotDomainsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListIotDomainsRequest.Builder	page(String page)	For list pagination: The value of the opc-next-page response header from the previous “List” call.
ListIotDomainsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListIotDomainsRequest.Builder	sortBy(ListIotDomainsRequest.SortBy sortBy)	The field to sort by.
ListIotDomainsRequest.Builder	sortOrder(ListIotDomainsRequest.SortOrder sortOrder)	Specifies sort order to use, either ASC (ascending) or DESC (descending).

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

compartmentId

public ListIotDomainsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

id

public ListIotDomainsRequest.Builder id(String id)

Filter resources by OCID.

Must be a valid OCID of the resource type.

Parameters:

id - the value to set

Returns:

this builder instance

iotDomainGroupId

public ListIotDomainsRequest.Builder iotDomainGroupId(String iotDomainGroupId)

Filter resources that match the specified OCID of the IoT domain group.

Parameters:

iotDomainGroupId - the value to set

Returns:

this builder instance

displayName

public ListIotDomainsRequest.Builder displayName(String displayName)

Filter resources whose display name matches the specified value.

Parameters:

displayName - the value to set

Returns:

this builder instance

lifecycleState

public ListIotDomainsRequest.Builder lifecycleState(IotDomain.LifecycleState lifecycleState)

Filter resources whose lifecycleState matches the specified value.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

limit

public ListIotDomainsRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListIotDomainsRequest.Builder page(String page)

For list pagination: The value of the opc-next-page response header from the previous “List” call.

For important details on how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListIotDomainsRequest.Builder sortOrder(ListIotDomainsRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListIotDomainsRequest.Builder sortBy(ListIotDomainsRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListIotDomainsRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request.

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

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListIotDomainsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListIotDomainsRequest build()

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

Returns:

instance of ListIotDomainsRequest

buildWithoutInvocationCallback

public ListIotDomainsRequest buildWithoutInvocationCallback()

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