Package com.oracle.bmc.tenantmanagercontrolplane.requests

Class ListDomainsRequest.Builder

java.lang.Object

com.oracle.bmc.tenantmanagercontrolplane.requests.ListDomainsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListDomainsRequest,Void>

Enclosing class:

ListDomainsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListDomainsRequest	build()	Build the instance of ListDomainsRequest as configured by this builder
ListDomainsRequest	buildWithoutInvocationCallback()	Build the instance of ListDomainsRequest as configured by this builder
ListDomainsRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListDomainsRequest.Builder	copy(ListDomainsRequest o)	Copy method to populate the builder with values from the given instance.
ListDomainsRequest.Builder	domainId(String domainId)	The domain OCID.
ListDomainsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListDomainsRequest.Builder	lifecycleState(LifecycleState lifecycleState)	The lifecycle state of the resource.
ListDomainsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListDomainsRequest.Builder	name(String name)	A filter to return only resources that exactly match the name given.
ListDomainsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListDomainsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListDomainsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListDomainsRequest.Builder	sortBy(ListDomainsRequest.SortBy sortBy)	The field to sort by.
ListDomainsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, whether ‘asc’ or ‘desc’.
ListDomainsRequest.Builder	status(Domain.Status status)	The status of the domain.

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 ListDomainsRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

domainId

public ListDomainsRequest.Builder domainId(String domainId)

The domain OCID.

Parameters:

domainId - the value to set

Returns:

this builder instance

lifecycleState

public ListDomainsRequest.Builder lifecycleState(LifecycleState lifecycleState)

The lifecycle state of the resource.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

status

public ListDomainsRequest.Builder status(Domain.Status status)

The status of the domain.

Parameters:

status - the value to set

Returns:

this builder instance

name

public ListDomainsRequest.Builder name(String name)

A filter to return only resources that exactly match the name given.

Parameters:

name - the value to set

Returns:

this builder instance

opcRequestId

public ListDomainsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

page

public ListDomainsRequest.Builder page(String page)

The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListDomainsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

sortBy

public ListDomainsRequest.Builder sortBy(ListDomainsRequest.SortBy sortBy)

The field to sort by.

Only one sort order can be provided. * The default order for timeCreated is descending. * The default order for displayName is ascending. * If no value is specified, timeCreated is the default.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListDomainsRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, whether ‘asc’ or ‘desc’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListDomainsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListDomainsRequest build()

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

Returns:

instance of ListDomainsRequest

buildWithoutInvocationCallback

public ListDomainsRequest buildWithoutInvocationCallback()

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