org.everit.atlassian.restclient.jiracloud.v2.model

Class FieldReferenceData

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.model.FieldReferenceData

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-11-13T15:26:36.903+01:00[Europe/Prague]")
public class FieldReferenceData
extends Object

Details of a field that can be used in advanced searches.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldReferenceData.AutoEnum Whether the field provide auto-complete suggestions.
static class	FieldReferenceData.DeprecatedEnum Whether this field has been deprecated.
static class	FieldReferenceData.OrderableEnum Whether the field can be used in a query's `ORDER BY` clause.
static class	FieldReferenceData.SearchableEnum Whether the content of this field can be searched.

Constructor Summary

Constructors

Constructor and Description
FieldReferenceData()

Method Summary

Modifier and Type	Method and Description
FieldReferenceData	addOperatorsItem(String operatorsItem)
FieldReferenceData	addTypesItem(String typesItem)
FieldReferenceData	auto(FieldReferenceData.AutoEnum auto)
FieldReferenceData	cfid(String cfid)
FieldReferenceData	deprecated(FieldReferenceData.DeprecatedEnum deprecated)
FieldReferenceData	deprecatedSearcherKey(String deprecatedSearcherKey)
FieldReferenceData	displayName(String displayName)
boolean	equals(Object o)
FieldReferenceData.AutoEnum	getAuto() Whether the field provide auto-complete suggestions.
String	getCfid() If the item is a custom field, the ID of the custom field.
FieldReferenceData.DeprecatedEnum	getDeprecated() Whether this field has been deprecated.
String	getDeprecatedSearcherKey() The searcher key of the field, only passed when the field is deprecated.
String	getDisplayName() The display name contains the following: * for system fields, the field name.
List<String>	getOperators() The valid search operators for the field.
FieldReferenceData.OrderableEnum	getOrderable() Whether the field can be used in a query's `ORDER BY` clause.
FieldReferenceData.SearchableEnum	getSearchable() Whether the content of this field can be searched.
List<String>	getTypes() The data types of items in the field.
String	getValue() The field identifier.
int	hashCode()
FieldReferenceData	operators(List<String> operators)
FieldReferenceData	orderable(FieldReferenceData.OrderableEnum orderable)
FieldReferenceData	searchable(FieldReferenceData.SearchableEnum searchable)
void	setAuto(FieldReferenceData.AutoEnum auto)
void	setCfid(String cfid)
void	setDeprecated(FieldReferenceData.DeprecatedEnum deprecated)
void	setDeprecatedSearcherKey(String deprecatedSearcherKey)
void	setDisplayName(String displayName)
void	setOperators(List<String> operators)
void	setOrderable(FieldReferenceData.OrderableEnum orderable)
void	setSearchable(FieldReferenceData.SearchableEnum searchable)
void	setTypes(List<String> types)
void	setValue(String value)
String	toString()
FieldReferenceData	types(List<String> types)
FieldReferenceData	value(String value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldReferenceData

public FieldReferenceData()

Method Detail

auto

public FieldReferenceData auto(FieldReferenceData.AutoEnum auto)

getAuto

public FieldReferenceData.AutoEnum getAuto()

Whether the field provide auto-complete suggestions.

Returns:

auto

setAuto

public void setAuto(FieldReferenceData.AutoEnum auto)

cfid

public FieldReferenceData cfid(String cfid)

getCfid

public String getCfid()

If the item is a custom field, the ID of the custom field.

Returns:

cfid

setCfid

public void setCfid(String cfid)

deprecated

public FieldReferenceData deprecated(FieldReferenceData.DeprecatedEnum deprecated)

getDeprecated

public FieldReferenceData.DeprecatedEnum getDeprecated()

Whether this field has been deprecated.

Returns:

deprecated

setDeprecated

public void setDeprecated(FieldReferenceData.DeprecatedEnum deprecated)

deprecatedSearcherKey

public FieldReferenceData deprecatedSearcherKey(String deprecatedSearcherKey)

getDeprecatedSearcherKey

public String getDeprecatedSearcherKey()

The searcher key of the field, only passed when the field is deprecated.

Returns:

deprecatedSearcherKey

setDeprecatedSearcherKey

public void setDeprecatedSearcherKey(String deprecatedSearcherKey)

displayName

public FieldReferenceData displayName(String displayName)

getDisplayName

public String getDisplayName()

The display name contains the following: * for system fields, the field name. For example, `Summary`. * for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example, `Component - Component[Dropdown]`. * for other custom fields, the field name followed by a hyphen and then the custom field ID. For example, `Component - cf[10061]`.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

operators

public FieldReferenceData operators(List<String> operators)

addOperatorsItem

public FieldReferenceData addOperatorsItem(String operatorsItem)

getOperators

public List<String> getOperators()

The valid search operators for the field.

Returns:

operators

setOperators

public void setOperators(List<String> operators)

orderable

public FieldReferenceData orderable(FieldReferenceData.OrderableEnum orderable)

getOrderable

public FieldReferenceData.OrderableEnum getOrderable()

Whether the field can be used in a query's `ORDER BY` clause.

Returns:

orderable

setOrderable

public void setOrderable(FieldReferenceData.OrderableEnum orderable)

searchable

public FieldReferenceData searchable(FieldReferenceData.SearchableEnum searchable)

getSearchable

public FieldReferenceData.SearchableEnum getSearchable()

Whether the content of this field can be searched.

Returns:

searchable

setSearchable

public void setSearchable(FieldReferenceData.SearchableEnum searchable)

types

public FieldReferenceData types(List<String> types)

addTypesItem

public FieldReferenceData addTypesItem(String typesItem)

getTypes

public List<String> getTypes()

The data types of items in the field.

Returns:

types

setTypes

public void setTypes(List<String> types)

value

public FieldReferenceData value(String value)

getValue

public String getValue()

The field identifier.

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