SearchMessagesParams (slack-base 1.4 API)

java.lang.Object
- com.hubspot.slack.client.methods.params.search.SearchMessagesParams

All Implemented Interfaces:: SearchMessagesParamsIF

@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","SearchMessagesParamsIF"})
 @Immutable
public final class SearchMessagesParams
extends Object
implements SearchMessagesParamsIF

Immutable implementation of SearchMessagesParamsIF.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SearchMessagesParams.Builder
Builds instances of type SearchMessagesParams.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SearchMessagesParams.Builder`	`builder()` Creates a builder for `SearchMessagesParams`.
`static SearchMessagesParams`	`copyOf(SearchMessagesParamsIF instance)` Creates an immutable copy of a `SearchMessagesParamsIF` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `SearchMessagesParams` that have equal attribute values.
`int`	`getCount()`
`int`	`getPage()`
`String`	`getQuery()`
`ResultSort`	`getSort()`
`ResultSortOrder`	`getSortOrder()`
`int`	`hashCode()` Computes a hash code from attributes: `query`, `shouldHighlight`, `count`, `page`, `sort`, `sortOrder`.
`boolean`	`shouldHighlight()`
`String`	`toString()` Prints the immutable value `SearchMessagesParams` with attribute values.
`SearchMessagesParams`	`withCount(int count)` Copy the current immutable object by setting a value for the `count` attribute.
`SearchMessagesParams`	`withPage(int page)` Copy the current immutable object by setting a value for the `page` attribute.
`SearchMessagesParams`	`withQuery(String query)` Copy the current immutable object by setting a value for the `query` attribute.
`SearchMessagesParams`	`withShouldHighlight(boolean shouldHighlight)` Copy the current immutable object by setting a value for the `shouldHighlight` attribute.
`SearchMessagesParams`	`withSort(ResultSort sort)` Copy the current immutable object by setting a value for the `sort` attribute.
`SearchMessagesParams`	`withSortOrder(ResultSortOrder sortOrder)` Copy the current immutable object by setting a value for the `sortOrder` attribute.

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

- Method Detail
  - getQuery
```
public String getQuery()
```
    Specified by:
    
    getQuery in interface SearchMessagesParamsIF
    
    Returns:
    
    The value of the query attribute
  - shouldHighlight
```
public boolean shouldHighlight()
```
    Specified by:
    
    shouldHighlight in interface SearchMessagesParamsIF
    
    Returns:
    
    The value of the shouldHighlight attribute
  - getCount
```
public int getCount()
```
    Specified by:
    
    getCount in interface SearchMessagesParamsIF
    
    Returns:
    
    The value of the count attribute
  - getPage
```
public int getPage()
```
    Specified by:
    
    getPage in interface SearchMessagesParamsIF
    
    Returns:
    
    The value of the page attribute
  - getSort
```
public ResultSort getSort()
```
    Specified by:
    
    getSort in interface SearchMessagesParamsIF
    
    Returns:
    
    The value of the sort attribute
  - getSortOrder
```
public ResultSortOrder getSortOrder()
```
    Specified by:
    
    getSortOrder in interface SearchMessagesParamsIF
    
    Returns:
    
    The value of the sortOrder attribute
  - withQuery
```
public final SearchMessagesParams withQuery(String query)
```
    Copy the current immutable object by setting a value for the query attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    query - A new value for query
    
    Returns:
    
    A modified copy of the this object
  - withShouldHighlight
```
public final SearchMessagesParams withShouldHighlight(boolean shouldHighlight)
```
    Copy the current immutable object by setting a value for the shouldHighlight attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    shouldHighlight - A new value for shouldHighlight
    
    Returns:
    
    A modified copy of the this object
  - withCount
```
public final SearchMessagesParams withCount(int count)
```
    Copy the current immutable object by setting a value for the count attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    count - A new value for count
    
    Returns:
    
    A modified copy of the this object
  - withPage
```
public final SearchMessagesParams withPage(int page)
```
    Copy the current immutable object by setting a value for the page attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    page - A new value for page
    
    Returns:
    
    A modified copy of the this object
  - withSort
```
public final SearchMessagesParams withSort(ResultSort sort)
```
    Copy the current immutable object by setting a value for the sort attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    sort - A new value for sort
    
    Returns:
    
    A modified copy of the this object
  - withSortOrder
```
public final SearchMessagesParams withSortOrder(ResultSortOrder sortOrder)
```
    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:
    
    sortOrder - A new value for sortOrder
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of SearchMessagesParams 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: query, shouldHighlight, count, page, sort, sortOrder.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value SearchMessagesParams with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static SearchMessagesParams copyOf(SearchMessagesParamsIF instance)
```
    Creates an immutable copy of a SearchMessagesParamsIF 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 SearchMessagesParams instance
  - builder
```
public static SearchMessagesParams.Builder builder()
```
    Creates a builder for SearchMessagesParams.
    
    Returns:
    
    A new SearchMessagesParams builder

Class SearchMessagesParams

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getQuery

shouldHighlight

getCount

getPage

getSort

getSortOrder

withQuery

withShouldHighlight

withCount

withPage

withSort

withSortOrder

equals

hashCode

toString

copyOf

builder