Class V1SecFilingParams.Body
-
- All Implemented Interfaces:
public final class V1SecFilingParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classV1SecFilingParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final V1SecFilingParams.Typetype()Run a full-text search or fetch a single entity filing history final Optional<String>cik()CIK for entity lookups. final Optional<LocalDate>dateAfter()Optional lower filing date bound (YYYY-MM-DD) final Optional<LocalDate>dateBefore()Optional upper filing date bound (YYYY-MM-DD) final Optional<String>entity()Optional entity filter passed through to EDGAR full-text search final Optional<List<String>>formTypes()Optional SEC form type filter such as 10-K, 10-Q, 8-K, or 4 final Optional<Long>limit()Maximum filings to return final Optional<Long>offset()Result offset for pagination final Optional<String>query()Full-text SEC search query (required for type: search) final Optional<String>ticker()Optional company ticker. final JsonField<V1SecFilingParams.Type>_type()Returns the raw JSON value of type. final JsonField<String>_cik()Returns the raw JSON value of cik. final JsonField<LocalDate>_dateAfter()Returns the raw JSON value of dateAfter. final JsonField<LocalDate>_dateBefore()Returns the raw JSON value of dateBefore. final JsonField<String>_entity()Returns the raw JSON value of entity. final JsonField<List<String>>_formTypes()Returns the raw JSON value of formTypes. final JsonField<Long>_limit()Returns the raw JSON value of limit. final JsonField<Long>_offset()Returns the raw JSON value of offset. final JsonField<String>_query()Returns the raw JSON value of query. final JsonField<String>_ticker()Returns the raw JSON value of ticker. final Map<String, JsonValue>_additionalProperties()final V1SecFilingParams.Body.BuildertoBuilder()final V1SecFilingParams.Bodyvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static V1SecFilingParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
type
final V1SecFilingParams.Type type()
Run a full-text search or fetch a single entity filing history
-
dateBefore
final Optional<LocalDate> dateBefore()
Optional upper filing date bound (YYYY-MM-DD)
-
entity
final Optional<String> entity()
Optional entity filter passed through to EDGAR full-text search
-
formTypes
final Optional<List<String>> formTypes()
Optional SEC form type filter such as 10-K, 10-Q, 8-K, or 4
-
ticker
final Optional<String> ticker()
Optional company ticker. Valid for both search and entity lookups.
-
_type
final JsonField<V1SecFilingParams.Type> _type()
Returns the raw JSON value of type.
Unlike type, this method doesn't throw if the JSON field has an unexpected type.
-
_cik
final JsonField<String> _cik()
Returns the raw JSON value of cik.
Unlike cik, this method doesn't throw if the JSON field has an unexpected type.
-
_dateAfter
final JsonField<LocalDate> _dateAfter()
Returns the raw JSON value of dateAfter.
Unlike dateAfter, this method doesn't throw if the JSON field has an unexpected type.
-
_dateBefore
final JsonField<LocalDate> _dateBefore()
Returns the raw JSON value of dateBefore.
Unlike dateBefore, this method doesn't throw if the JSON field has an unexpected type.
-
_entity
final JsonField<String> _entity()
Returns the raw JSON value of entity.
Unlike entity, this method doesn't throw if the JSON field has an unexpected type.
-
_formTypes
final JsonField<List<String>> _formTypes()
Returns the raw JSON value of formTypes.
Unlike formTypes, this method doesn't throw if the JSON field has an unexpected type.
-
_limit
final JsonField<Long> _limit()
Returns the raw JSON value of limit.
Unlike limit, this method doesn't throw if the JSON field has an unexpected type.
-
_offset
final JsonField<Long> _offset()
Returns the raw JSON value of offset.
Unlike offset, this method doesn't throw if the JSON field has an unexpected type.
-
_query
final JsonField<String> _query()
Returns the raw JSON value of query.
Unlike query, this method doesn't throw if the JSON field has an unexpected type.
-
_ticker
final JsonField<String> _ticker()
Returns the raw JSON value of ticker.
Unlike ticker, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final V1SecFilingParams.Body.Builder toBuilder()
-
validate
final V1SecFilingParams.Body validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static V1SecFilingParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.type()
-
-
-
-