ImmutableScimSearchRequest (scim-model 1.114.0 API)

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

@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","ScimSearchRequest"})
 @Immutable
public final class ImmutableScimSearchRequest
extends ScimSearchRequest

Immutable implementation of ScimSearchRequest.

Use the builder to create immutable instances: ImmutableScimSearchRequest.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableScimSearchRequest.Builder
Builds instances of type ImmutableScimSearchRequest.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableScimSearchRequest.Builder` Builds instances of type `ImmutableScimSearchRequest`.

Field Summary
- Fields inherited from class com.atlassian.idp.model.ScimSearchRequest
  SCHEMA

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableScimSearchRequest.Builder`	`builder()` Creates a builder for `ImmutableScimSearchRequest`.
`static ImmutableScimSearchRequest`	`copyOf(ScimSearchRequest instance)` Creates an immutable copy of a `ScimSearchRequest` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableScimSearchRequest` that have equal attribute values.
`List<String>`	`getAttributes()`
`Integer`	`getCount()` Specifies the desired maximum number of query results per page, e.g., 10.
`List<String>`	`getExcludedAttributes()`
`String`	`getFilter()`
`List<String>`	`getSchemas()`
`String`	`getSortBy()`
`ScimSortOrder`	`getSortOrder()`
`Integer`	`getStartIndex()` The 1-based index of the first query result.
`int`	`hashCode()` Computes a hash code from attributes: `schemas`, `attributes`, `excludedAttributes`, `filter`, `sortBy`, `sortOrder`, `startIndex`, `count`, `shouldHideResources`.
`boolean`	`shouldHideResources()` A count of "0" indicates that no resource results are to be returned except for "totalResults".
`String`	`toString()` Prints the immutable value `ScimSearchRequest` with attribute values.
`ImmutableScimSearchRequest`	`withAttributes(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `attributes`.
`ImmutableScimSearchRequest`	`withAttributes(String... elements)` Copy the current immutable object with elements that replace the content of `attributes`.
`ImmutableScimSearchRequest`	`withCount(Integer value)` Copy the current immutable object by setting a value for the `count` attribute.
`ImmutableScimSearchRequest`	`withExcludedAttributes(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `excludedAttributes`.
`ImmutableScimSearchRequest`	`withExcludedAttributes(String... elements)` Copy the current immutable object with elements that replace the content of `excludedAttributes`.
`ImmutableScimSearchRequest`	`withFilter(String value)` Copy the current immutable object by setting a value for the `filter` attribute.
`ImmutableScimSearchRequest`	`withSchemas(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `schemas`.
`ImmutableScimSearchRequest`	`withSchemas(String... elements)` Copy the current immutable object with elements that replace the content of `schemas`.
`ImmutableScimSearchRequest`	`withSortBy(String value)` Copy the current immutable object by setting a value for the `sortBy` attribute.
`ImmutableScimSearchRequest`	`withSortOrder(ScimSortOrder value)` Copy the current immutable object by setting a value for the `sortOrder` attribute.
`ImmutableScimSearchRequest`	`withStartIndex(Integer value)` Copy the current immutable object by setting a value for the `startIndex` attribute.

Methods inherited from class com.atlassian.idp.model.ScimSearchRequest
normalizeCount, normalizeStartIndex

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

- Method Detail
  - getSchemas
```
public List<String> getSchemas()
```
    Overrides:
    
    getSchemas in class ScimSearchRequest
    
    Returns:
    
    the schemas used in this search request
  - getAttributes
```
@Nullable
public List<String> getAttributes()
```
    Specified by:
    
    getAttributes in class ScimSearchRequest
    
    Returns:
    
    the names of resource attributes to return in the response.
  - getExcludedAttributes
```
@Nullable
public List<String> getExcludedAttributes()
```
    Specified by:
    
    getExcludedAttributes in class ScimSearchRequest
    
    Returns:
    
    the names of resource attributes to be removed from the default set of attributes to return.
  - getFilter
```
@Nullable
public String getFilter()
```
    Specified by:
    
    getFilter in class ScimSearchRequest
    
    Returns:
    
    The filter string used to request a subset of resources.
  - getSortBy
```
@Nullable
public String getSortBy()
```
    Specified by:
    
    getSortBy in class ScimSearchRequest
    
    Returns:
    
    A string indicating the attribute whose value SHALL be used to order the returned responses.
  - getSortOrder
```
@Nullable
public ScimSortOrder getSortOrder()
```
    Specified by:
    
    getSortOrder in class ScimSearchRequest
    
    Returns:
    
    the order in which the "sortBy" parameter is applied. Allowed values are "ascending" and "descending".
  - getStartIndex
```
@Nullable
public Integer getStartIndex()
```
    The 1-based index of the first query result.
    A value less than 1 will be interpreted as 1.
    
    Specified by:
    
    getStartIndex in class ScimSearchRequest
    
    Returns:
    
    the 1-based index of the first query result.
  - getCount
```
@Nullable
public Integer getCount()
```
    Specifies the desired maximum number of query results per page, e.g., 10.
    A negative value will be interpreted as "0". A value of "0" indicates that no resource results are to be returned except for "totalResults".
    
    Specified by:
    
    getCount in class ScimSearchRequest
    
    Returns:
    
    the desired maximum number of query results per page.
  - shouldHideResources
```
public boolean shouldHideResources()
```
    A count of "0" indicates that no resource results are to be returned except for "totalResults".
    
    Overrides:
    
    shouldHideResources in class ScimSearchRequest
    
    Returns:
    
    true if getCount() ()} returns 0
  - withSchemas
```
public final ImmutableScimSearchRequest withSchemas(String... elements)
```
    Copy the current immutable object with elements that replace the content of schemas.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withSchemas
```
public final ImmutableScimSearchRequest withSchemas(Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of schemas. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of schemas elements to set
    
    Returns:
    
    A modified copy of this object
  - withAttributes
```
public final ImmutableScimSearchRequest withAttributes(@Nullable
                                                       String... elements)
```
    Copy the current immutable object with elements that replace the content of attributes.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withAttributes
```
public final ImmutableScimSearchRequest withAttributes(@Nullable
                                                       Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of attributes. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of attributes elements to set
    
    Returns:
    
    A modified copy of this object
  - withExcludedAttributes
```
public final ImmutableScimSearchRequest withExcludedAttributes(@Nullable
                                                               String... elements)
```
    Copy the current immutable object with elements that replace the content of excludedAttributes.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withExcludedAttributes
```
public final ImmutableScimSearchRequest withExcludedAttributes(@Nullable
                                                               Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of excludedAttributes. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of excludedAttributes elements to set
    
    Returns:
    
    A modified copy of this object
  - withFilter
```
public final ImmutableScimSearchRequest withFilter(@Nullable
                                                   String value)
```
    Copy the current immutable object by setting a value for the filter attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for filter (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withSortBy
```
public final ImmutableScimSearchRequest withSortBy(@Nullable
                                                   String value)
```
    Copy the current immutable object by setting a value for the sortBy attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for sortBy (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withSortOrder
```
public final ImmutableScimSearchRequest withSortOrder(@Nullable
                                                      ScimSortOrder value)
```
    Copy the current immutable object by setting a value for the sortOrder attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for sortOrder (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withStartIndex
```
public final ImmutableScimSearchRequest withStartIndex(@Nullable
                                                       Integer value)
```
    Copy the current immutable object by setting a value for the startIndex attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for startIndex (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withCount
```
public final ImmutableScimSearchRequest withCount(@Nullable
                                                  Integer value)
```
    Copy the current immutable object by setting a value for the count attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for count (can be null)
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableScimSearchRequest that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: schemas, attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count, shouldHideResources.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value ScimSearchRequest with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableScimSearchRequest copyOf(ScimSearchRequest instance)
```
    Creates an immutable copy of a ScimSearchRequest value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable ScimSearchRequest instance
  - builder
```
public static ImmutableScimSearchRequest.Builder builder()
```
    Creates a builder for ImmutableScimSearchRequest.
    
    Returns:
    
    A new ImmutableScimSearchRequest builder

Class ImmutableScimSearchRequest

Nested Class Summary

Field Summary

Fields inherited from class com.atlassian.idp.model.ScimSearchRequest

Method Summary

Methods inherited from class com.atlassian.idp.model.ScimSearchRequest

Methods inherited from class java.lang.Object

Method Detail

getSchemas

getAttributes

getExcludedAttributes

getFilter

getSortBy

getSortOrder

getStartIndex

getCount

shouldHideResources

withSchemas

withSchemas

withAttributes

withAttributes

withExcludedAttributes

withExcludedAttributes

withFilter

withSortBy

withSortOrder

withStartIndex

withCount

equals

hashCode

toString

copyOf

builder