ListDomainsRequest.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.identity.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 and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 OCID of the compartment (remember that the tenancy is simply the root compartment).
`ListDomainsRequest.Builder`	`copy(ListDomainsRequest o)` Copy method to populate the builder with values from the given instance.
`ListDomainsRequest.Builder`	`displayName(String displayName)` The mutable display name of the identity domain.
`ListDomainsRequest.Builder`	`homeRegionUrl(String homeRegionUrl)` The region-specific identity domain URL.
`ListDomainsRequest.Builder`	`invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)` Set the invocation callback for the request to be built.
`ListDomainsRequest.Builder`	`isHiddenOnLogin(Boolean isHiddenOnLogin)` Indicates whether or not the identity domain is visible at the sign-in screen.
`ListDomainsRequest.Builder`	`licenseType(String licenseType)` The license type of the identity domain.
`ListDomainsRequest.Builder`	`lifecycleState(Domain.LifecycleState lifecycleState)` A filter to only return resources that match the given lifecycle state.
`ListDomainsRequest.Builder`	`limit(Integer limit)` The maximum number of items to return in a paginated “List” call.
`ListDomainsRequest.Builder`	`name(String name)` A filter to only return resources that match the given name exactly.
`ListDomainsRequest.Builder`	`opcRequestId(String opcRequestId)` Unique Oracle-assigned identifier for the request.
`ListDomainsRequest.Builder`	`page(String page)` The value of the `opc-next-page` response header from the previous “List” call.
`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(ListDomainsRequest.SortOrder sortOrder)` The sort order to use, either ascending (`ASC`) or descending (`DESC`).
`ListDomainsRequest.Builder`	`type(String type)` The identity domain type.
`ListDomainsRequest.Builder`	`url(String url)` The region-agnostic identity domain URL.

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 OCID of the compartment (remember that the tenancy is simply the root compartment).
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder instance
  - displayName
```
public ListDomainsRequest.Builder displayName(String displayName)
```
    The mutable display name of the identity domain.
    
    Parameters:
    
    displayName - the value to set
    
    Returns:
    
    this builder instance
  - url
```
public ListDomainsRequest.Builder url(String url)
```
    The region-agnostic identity domain URL.
    
    Parameters:
    
    url - the value to set
    
    Returns:
    
    this builder instance
  - homeRegionUrl
```
public ListDomainsRequest.Builder homeRegionUrl(String homeRegionUrl)
```
    The region-specific identity domain URL.
    
    Parameters:
    
    homeRegionUrl - the value to set
    
    Returns:
    
    this builder instance
  - type
```
public ListDomainsRequest.Builder type(String type)
```
    The identity domain type.
    
    Parameters:
    
    type - the value to set
    
    Returns:
    
    this builder instance
  - licenseType
```
public ListDomainsRequest.Builder licenseType(String licenseType)
```
    The license type of the identity domain.
    
    Parameters:
    
    licenseType - the value to set
    
    Returns:
    
    this builder instance
  - isHiddenOnLogin
```
public ListDomainsRequest.Builder isHiddenOnLogin(Boolean isHiddenOnLogin)
```
    Indicates whether or not the identity domain is visible at the sign-in screen.
    
    Parameters:
    
    isHiddenOnLogin - the value to set
    
    Returns:
    
    this builder instance
  - page
```
public ListDomainsRequest.Builder page(String page)
```
    The value of the opc-next-page response header from the 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 in a paginated “List” call.
    
    Parameters:
    
    limit - the value to set
    
    Returns:
    
    this builder instance
  - name
```
public ListDomainsRequest.Builder name(String name)
```
    A filter to only return resources that match the given name exactly.
    
    Parameters:
    
    name - the value to set
    
    Returns:
    
    this builder instance
  - sortBy
```
public ListDomainsRequest.Builder sortBy(ListDomainsRequest.SortBy sortBy)
```
    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
    
    *Note:** In general, some "List" operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.
    
    Parameters:
    
    sortBy - the value to set
    
    Returns:
    
    this builder instance
  - sortOrder
```
public ListDomainsRequest.Builder sortOrder(ListDomainsRequest.SortOrder sortOrder)
```
    The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.
    
    Parameters:
    
    sortOrder - the value to set
    
    Returns:
    
    this builder instance
  - opcRequestId
```
public ListDomainsRequest.Builder opcRequestId(String opcRequestId)
```
    Unique Oracle-assigned 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
  - lifecycleState
```
public ListDomainsRequest.Builder lifecycleState(Domain.LifecycleState lifecycleState)
```
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    
    Parameters:
    
    lifecycleState - 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

Class ListDomainsRequest.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

Method Detail

compartmentId

displayName

url

homeRegionUrl

type

licenseType

isHiddenOnLogin

page

limit

name

sortBy

sortOrder

opcRequestId

lifecycleState

invocationCallback

retryConfiguration

copy

build

buildWithoutInvocationCallback