Package io.github.primelib.jira4j.restv2.model

Class FieldReferenceData

java.lang.Object

io.github.primelib.jira4j.restv2.model.FieldReferenceData

@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator")
public class FieldReferenceData
extends Object

FieldReferenceData

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected FieldReferenceData.AutoEnum	auto	Whether the field provide auto-complete suggestions.
protected String	cfid	If the item is a custom field, the ID of the custom field.
protected FieldReferenceData.DeprecatedEnum	deprecated	Whether this field has been deprecated.
protected String	deprecatedSearcherKey	The searcher key of the field, only passed when the field is deprecated.
protected String	displayName	The display name contains the following: * for system fields, the field name.
protected List<String>	operators	The valid search operators for the field.
protected FieldReferenceData.OrderableEnum	orderable	Whether the field can be used in a query's ORDER BY clause.
protected FieldReferenceData.SearchableEnum	searchable	Whether the content of this field can be searched.
protected List<String>	types	The data types of items in the field.
protected String	value	The field identifier.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldReferenceData()
	FieldReferenceData(FieldReferenceData.AutoEnum auto, String cfid, FieldReferenceData.DeprecatedEnum deprecated, String deprecatedSearcherKey, String displayName, List<String> operators, FieldReferenceData.OrderableEnum orderable, FieldReferenceData.SearchableEnum searchable, List<String> types, String value)	Constructs a validated instance of FieldReferenceData.
	FieldReferenceData(Consumer<FieldReferenceData> spec)	Constructs a validated instance of FieldReferenceData.

Method Summary

Modifier and Type	Method	Description
FieldReferenceData.AutoEnum	auto()	Whether the field provide auto-complete suggestions.
FieldReferenceData	auto(FieldReferenceData.AutoEnum auto)	Whether the field provide auto-complete suggestions.
static FieldReferenceData.FieldReferenceDataBuilder	builder()
protected boolean	canEqual(Object other)
String	cfid()	If the item is a custom field, the ID of the custom field.
FieldReferenceData	cfid(String cfid)	If the item is a custom field, the ID of the custom field.
FieldReferenceData.DeprecatedEnum	deprecated()	Whether this field has been deprecated.
FieldReferenceData	deprecated(FieldReferenceData.DeprecatedEnum deprecated)	Whether this field has been deprecated.
String	deprecatedSearcherKey()	The searcher key of the field, only passed when the field is deprecated.
FieldReferenceData	deprecatedSearcherKey(String deprecatedSearcherKey)	The searcher key of the field, only passed when the field is deprecated.
String	displayName()	The display name contains the following: * for system fields, the field name.
FieldReferenceData	displayName(String displayName)	The display name contains the following: * for system fields, the field name.
boolean	equals(Object o)
int	hashCode()
List<String>	operators()	The valid search operators for the field.
FieldReferenceData	operators(List<String> operators)	The valid search operators for the field.
FieldReferenceData.OrderableEnum	orderable()	Whether the field can be used in a query's ORDER BY clause.
FieldReferenceData	orderable(FieldReferenceData.OrderableEnum orderable)	Whether the field can be used in a query's ORDER BY clause.
FieldReferenceData.SearchableEnum	searchable()	Whether the content of this field can be searched.
FieldReferenceData	searchable(FieldReferenceData.SearchableEnum searchable)	Whether the content of this field can be searched.
String	toString()
List<String>	types()	The data types of items in the field.
FieldReferenceData	types(List<String> types)	The data types of items in the field.
String	value()	The field identifier.
FieldReferenceData	value(String value)	The field identifier.

Methods inherited from class java.lang.Object

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

Field Details

auto

protected FieldReferenceData.AutoEnum auto

Whether the field provide auto-complete suggestions.

cfid

protected String cfid

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

deprecated

protected FieldReferenceData.DeprecatedEnum deprecated

Whether this field has been deprecated.

deprecatedSearcherKey

protected String deprecatedSearcherKey

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

displayName

protected String displayName

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].

operators

protected List<String> operators

The valid search operators for the field.

orderable

protected FieldReferenceData.OrderableEnum orderable

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

searchable

protected FieldReferenceData.SearchableEnum searchable

Whether the content of this field can be searched.

types

protected List<String> types

The data types of items in the field.

value

protected String value

The field identifier.

Constructor Details

FieldReferenceData

public FieldReferenceData(Consumer<FieldReferenceData> spec)

Constructs a validated instance of FieldReferenceData.

Parameters:

spec - the specification to process

FieldReferenceData

@Internal
public FieldReferenceData(FieldReferenceData.AutoEnum auto,
 String cfid,
 FieldReferenceData.DeprecatedEnum deprecated,
 String deprecatedSearcherKey,
 String displayName,
 List<String> operators,
 FieldReferenceData.OrderableEnum orderable,
 FieldReferenceData.SearchableEnum searchable,
 List<String> types,
 String value)

Constructs a validated instance of FieldReferenceData.

NOTE: This constructor is not considered stable and may change if the model is updated. Consider using FieldReferenceData(Consumer) instead.

Parameters:

auto - Whether the field provide auto-complete suggestions.

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

deprecated - Whether this field has been deprecated.

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

displayName - 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].

operators - The valid search operators for the field.

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

searchable - Whether the content of this field can be searched.

types - The data types of items in the field.

value - The field identifier.

FieldReferenceData

protected FieldReferenceData()

Method Details

builder

public static FieldReferenceData.FieldReferenceDataBuilder builder()

auto

public FieldReferenceData.AutoEnum auto()

Whether the field provide auto-complete suggestions.

cfid

public String cfid()

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

deprecated

public FieldReferenceData.DeprecatedEnum deprecated()

Whether this field has been deprecated.

deprecatedSearcherKey

public String deprecatedSearcherKey()

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

displayName

public String displayName()

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].

operators

public List<String> operators()

The valid search operators for the field.

orderable

public FieldReferenceData.OrderableEnum orderable()

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

searchable

public FieldReferenceData.SearchableEnum searchable()

Whether the content of this field can be searched.

types

public List<String> types()

The data types of items in the field.

value

public String value()

The field identifier.

auto

public FieldReferenceData auto(FieldReferenceData.AutoEnum auto)

Whether the field provide auto-complete suggestions.

Returns:

this.

cfid

public FieldReferenceData cfid(String cfid)

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

Returns:

this.

deprecated

public FieldReferenceData deprecated(FieldReferenceData.DeprecatedEnum deprecated)

Whether this field has been deprecated.

Returns:

this.

deprecatedSearcherKey

public FieldReferenceData deprecatedSearcherKey(String deprecatedSearcherKey)

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

Returns:

this.

displayName

public FieldReferenceData displayName(String displayName)

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:

this.

operators

public FieldReferenceData operators(List<String> operators)

The valid search operators for the field.

Returns:

this.

orderable

public FieldReferenceData orderable(FieldReferenceData.OrderableEnum orderable)

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

Returns:

this.

searchable

public FieldReferenceData searchable(FieldReferenceData.SearchableEnum searchable)

Whether the content of this field can be searched.

Returns:

this.

types

public FieldReferenceData types(List<String> types)

The data types of items in the field.

Returns:

this.

value

public FieldReferenceData value(String value)

The field identifier.

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object