ImmutableScimSearchRequest.Builder (scim-model 1.114.0 API)

java.lang.Object
- com.atlassian.idp.model.ImmutableScimSearchRequest.Builder

Enclosing class:

ImmutableScimSearchRequest
```
@NotThreadSafe
public static final class ImmutableScimSearchRequest.Builder
extends Object
```
Builds instances of type ImmutableScimSearchRequest. Initialize attributes and then invoke the build() method to create an immutable instance.
Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImmutableScimSearchRequest.Builder`	`addAllAttributes(Iterable<String> elements)` Adds elements to `attributes` list.
`ImmutableScimSearchRequest.Builder`	`addAllExcludedAttributes(Iterable<String> elements)` Adds elements to `excludedAttributes` list.
`ImmutableScimSearchRequest.Builder`	`addAllSchemas(Iterable<String> elements)` Adds elements to `schemas` list.
`ImmutableScimSearchRequest.Builder`	`addAttributes(String... elements)` Adds elements to `attributes` list.
`ImmutableScimSearchRequest.Builder`	`addAttributes(String element)` Adds one element to `attributes` list.
`ImmutableScimSearchRequest.Builder`	`addExcludedAttributes(String... elements)` Adds elements to `excludedAttributes` list.
`ImmutableScimSearchRequest.Builder`	`addExcludedAttributes(String element)` Adds one element to `excludedAttributes` list.
`ImmutableScimSearchRequest.Builder`	`addSchemas(String... elements)` Adds elements to `schemas` list.
`ImmutableScimSearchRequest.Builder`	`addSchemas(String element)` Adds one element to `schemas` list.
`ImmutableScimSearchRequest`	`build()` Builds a new `ImmutableScimSearchRequest`.
`ImmutableScimSearchRequest.Builder`	`from(ScimSearchRequest instance)` Fill a builder with attribute values from the provided `ScimSearchRequest` instance.
`ImmutableScimSearchRequest.Builder`	`withAttributes(Iterable<String> elements)` Sets or replaces all elements for `attributes` list.
`ImmutableScimSearchRequest.Builder`	`withCount(Integer count)` Initializes the value for the `count` attribute.
`ImmutableScimSearchRequest.Builder`	`withExcludedAttributes(Iterable<String> elements)` Sets or replaces all elements for `excludedAttributes` list.
`ImmutableScimSearchRequest.Builder`	`withFilter(String filter)` Initializes the value for the `filter` attribute.
`ImmutableScimSearchRequest.Builder`	`withSchemas(Iterable<String> elements)` Sets or replaces all elements for `schemas` list.
`ImmutableScimSearchRequest.Builder`	`withSortBy(String sortBy)` Initializes the value for the `sortBy` attribute.
`ImmutableScimSearchRequest.Builder`	`withSortOrder(ScimSortOrder sortOrder)` Initializes the value for the `sortOrder` attribute.
`ImmutableScimSearchRequest.Builder`	`withStartIndex(Integer startIndex)` Initializes the value for the `startIndex` attribute.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - from
```
public final ImmutableScimSearchRequest.Builder from(ScimSearchRequest instance)
```
    Fill a builder with attribute values from the provided ScimSearchRequest instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - addSchemas
```
public final ImmutableScimSearchRequest.Builder addSchemas(String element)
```
    Adds one element to schemas list.
    
    Parameters:
    
    element - A schemas element
    
    Returns:
    
    this builder for use in a chained invocation
  - addSchemas
```
public final ImmutableScimSearchRequest.Builder addSchemas(String... elements)
```
    Adds elements to schemas list.
    
    Parameters:
    
    elements - An array of schemas elements
    
    Returns:
    
    this builder for use in a chained invocation
  - withSchemas
```
public final ImmutableScimSearchRequest.Builder withSchemas(Iterable<String> elements)
```
    Sets or replaces all elements for schemas list.
    
    Parameters:
    
    elements - An iterable of schemas elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllSchemas
```
public final ImmutableScimSearchRequest.Builder addAllSchemas(Iterable<String> elements)
```
    Adds elements to schemas list.
    
    Parameters:
    
    elements - An iterable of schemas elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAttributes
```
public final ImmutableScimSearchRequest.Builder addAttributes(String element)
```
    Adds one element to attributes list.
    
    Parameters:
    
    element - A attributes element
    
    Returns:
    
    this builder for use in a chained invocation
  - addAttributes
```
public final ImmutableScimSearchRequest.Builder addAttributes(String... elements)
```
    Adds elements to attributes list.
    
    Parameters:
    
    elements - An array of attributes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - withAttributes
```
public final ImmutableScimSearchRequest.Builder withAttributes(@Nullable
                                                               Iterable<String> elements)
```
    Sets or replaces all elements for attributes list.
    
    Parameters:
    
    elements - An iterable of attributes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllAttributes
```
public final ImmutableScimSearchRequest.Builder addAllAttributes(Iterable<String> elements)
```
    Adds elements to attributes list.
    
    Parameters:
    
    elements - An iterable of attributes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addExcludedAttributes
```
public final ImmutableScimSearchRequest.Builder addExcludedAttributes(String element)
```
    Adds one element to excludedAttributes list.
    
    Parameters:
    
    element - A excludedAttributes element
    
    Returns:
    
    this builder for use in a chained invocation
  - addExcludedAttributes
```
public final ImmutableScimSearchRequest.Builder addExcludedAttributes(String... elements)
```
    Adds elements to excludedAttributes list.
    
    Parameters:
    
    elements - An array of excludedAttributes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - withExcludedAttributes
```
public final ImmutableScimSearchRequest.Builder withExcludedAttributes(@Nullable
                                                                       Iterable<String> elements)
```
    Sets or replaces all elements for excludedAttributes list.
    
    Parameters:
    
    elements - An iterable of excludedAttributes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllExcludedAttributes
```
public final ImmutableScimSearchRequest.Builder addAllExcludedAttributes(Iterable<String> elements)
```
    Adds elements to excludedAttributes list.
    
    Parameters:
    
    elements - An iterable of excludedAttributes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - withFilter
```
public final ImmutableScimSearchRequest.Builder withFilter(@Nullable
                                                           String filter)
```
    Initializes the value for the filter attribute.
    
    Parameters:
    
    filter - The value for filter (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - withSortBy
```
public final ImmutableScimSearchRequest.Builder withSortBy(@Nullable
                                                           String sortBy)
```
    Initializes the value for the sortBy attribute.
    
    Parameters:
    
    sortBy - The value for sortBy (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - withSortOrder
```
public final ImmutableScimSearchRequest.Builder withSortOrder(@Nullable
                                                              ScimSortOrder sortOrder)
```
    Initializes the value for the sortOrder attribute.
    
    Parameters:
    
    sortOrder - The value for sortOrder (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - withStartIndex
```
public final ImmutableScimSearchRequest.Builder withStartIndex(@Nullable
                                                               Integer startIndex)
```
    Initializes the value for the startIndex attribute.
    
    Parameters:
    
    startIndex - The value for startIndex (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - withCount
```
public final ImmutableScimSearchRequest.Builder withCount(@Nullable
                                                          Integer count)
```
    Initializes the value for the count attribute.
    
    Parameters:
    
    count - The value for count (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - build
```
public ImmutableScimSearchRequest build()
```
    Builds a new ImmutableScimSearchRequest.
    
    Returns:
    
    An immutable instance of ScimSearchRequest
    
    Throws:
    
    IllegalStateException - if any required attributes are missing

Class ImmutableScimSearchRequest.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

from

addSchemas

addSchemas

withSchemas

addAllSchemas

addAttributes

addAttributes

withAttributes

addAllAttributes

addExcludedAttributes

addExcludedAttributes

withExcludedAttributes

addAllExcludedAttributes

withFilter

withSortBy

withSortOrder

withStartIndex

withCount

build