Struct SearchRequestBean

pub struct SearchRequestBean {
    pub jql: Option<String>,
    pub start_at: Option<i32>,
    pub max_results: Option<i32>,
    pub fields: Option<Vec<String>>,
    pub validate_query: Option<ValidateQuery>,
    pub expand: Option<Vec<String>>,
    pub properties: Option<Vec<String>>,
    pub fields_by_keys: Option<bool>,
}

Fields

jql: Option<String>

A JQL expression.

start_at: Option<i32>

The index of the first item to return in the page of results (page offset). The base index is 0.

max_results: Option<i32>

The maximum number of items to return per page.

fields: Option<Vec<String>>

A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: * *all Returns all fields. * *navigable Returns navigable fields. * Any issue field, prefixed with a minus to exclude. The default is *navigable. Examples: * summary,comment Returns the summary and comments fields only. * -description Returns all navigable (default) fields except description. * *all,-comment Returns all fields except comments. Multiple fields parameters can be included in a request. Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.

validate_query: Option<ValidateQuery>

Determines how to validate the JQL query and treat the validation results. Supported values: * strict Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). * warn Returns all errors as warnings. * none No validation is performed. * true Deprecated A legacy synonym for strict. * false Deprecated A legacy synonym for warn. The default is strict. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.

expand: Option<Vec<String>>

Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a list of values. The expand options are: * renderedFields Returns field values rendered in HTML format. * names Returns the display name of each field. * schema Returns the schema describing a field type. * transitions Returns all possible transitions for the issue. * operations Returns all possible operations for the issue. * editmeta Returns information about how each field can be edited. * changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field’s value, with the highest numbered item representing the most recent version.

properties: Option<Vec<String>>

A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.

fields_by_keys: Option<bool>

Reference fields by their key (rather than ID). The default is false.

Implementations

impl SearchRequestBean

pub fn new() -> SearchRequestBean

Trait Implementations

impl Clone for SearchRequestBean

fn clone(&self) -> SearchRequestBean

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchRequestBean

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchRequestBean

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchRequestBean

fn eq(&self, other: &SearchRequestBean) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SearchRequestBean

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SearchRequestBean