java.lang.Object
- com.twitter.clientlib.model.Rule

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class Rule
extends Object

A user-provided stream filtering rule.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Rule.CustomTypeAdapterFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_TAG`
`static String`	`SERIALIZED_NAME_VALUE`

Constructor Summary

Constructors
Constructor Description

Rule()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`static Rule`	`fromJson(String jsonString)`	Create an instance of Rule given an JSON string
`String`	`getId()`	Unique identifier of this rule.
`String`	`getTag()`	A tag meant for the labeling of user provided rules.
`String`	`getValue()`	The filterlang value of the rule.
`int`	`hashCode()`
`Rule`	`id(String id)`
`void`	`setId(String id)`
`void`	`setTag(String tag)`
`void`	`setValue(String value)`
`Rule`	`tag(String tag)`
`String`	`toJson()`	Convert an instance of Rule to an JSON string
`String`	`toString()`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)`	Validates the JSON Object and throws an exception if issues found
`Rule`	`value(String value)`

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

- Field Detail
  - SERIALIZED_NAME_ID
```
public static final String SERIALIZED_NAME_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TAG
```
public static final String SERIALIZED_NAME_TAG
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VALUE
```
public static final String SERIALIZED_NAME_VALUE
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - id
```
public Rule id(String id)
```
  - getId
```
@Nullable
public String getId()
```
    Unique identifier of this rule.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - tag
```
public Rule tag(String tag)
```
  - getTag
```
@Nullable
public String getTag()
```
    A tag meant for the labeling of user provided rules.
    
    Returns:
    
    tag
  - setTag
```
public void setTag(String tag)
```
  - value
```
public Rule value(String value)
```
  - getValue
```
@Nonnull
public String getValue()
```
    The filterlang value of the rule.
    
    Returns:
    
    value
  - setValue
```
public void setValue(String value)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validateJsonObject
```
public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException
```
    Validates the JSON Object and throws an exception if issues found
    
    Parameters:
    
    jsonObj - JSON Object
    
    Throws:
    
    IOException - if the JSON Object is invalid with respect to Rule
  - fromJson
```
public static Rule fromJson(String jsonString)
                     throws IOException
```
    Create an instance of Rule given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of Rule
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to Rule
  - toJson
```
public String toJson()
```
    Convert an instance of Rule to an JSON string
    
    Returns:
    
    JSON string

Class Rule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_TAG

SERIALIZED_NAME_VALUE

openapiFields

openapiRequiredFields

Constructor Detail

Rule

Method Detail

id

getId

setId

tag

getTag

setTag

value

getValue

setValue

equals

hashCode

toString

validateJsonObject

fromJson

toJson