Constructor Detail

Method Detail

• body

   final V1SecFilingParams.Builder body(V1SecFilingParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • type

  • cik

  • dateAfter

  • dateBefore

  • entity

  • etc.

• type

   final V1SecFilingParams.Builder type(V1SecFilingParams.Type type)

  Run a full-text search or fetch a single entity filing history

• type

   final V1SecFilingParams.Builder type(JsonField<V1SecFilingParams.Type> type)

  Sets Builder.type to an arbitrary JSON value.

  You should usually call Builder.type with a well-typed Type value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• cik

   final V1SecFilingParams.Builder cik(String cik)

  CIK for entity lookups. Accepts padded or unpadded digits.

• cik

   final V1SecFilingParams.Builder cik(JsonField<String> cik)

  Sets Builder.cik to an arbitrary JSON value.

  You should usually call Builder.cik with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• dateAfter

   final V1SecFilingParams.Builder dateAfter(LocalDate dateAfter)

  Optional lower filing date bound (YYYY-MM-DD)

• dateAfter

   final V1SecFilingParams.Builder dateAfter(JsonField<LocalDate> dateAfter)

  Sets Builder.dateAfter to an arbitrary JSON value.

  You should usually call Builder.dateAfter with a well-typed LocalDate value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• dateBefore

   final V1SecFilingParams.Builder dateBefore(LocalDate dateBefore)

  Optional upper filing date bound (YYYY-MM-DD)

• dateBefore

   final V1SecFilingParams.Builder dateBefore(JsonField<LocalDate> dateBefore)

  Sets Builder.dateBefore to an arbitrary JSON value.

  You should usually call Builder.dateBefore with a well-typed LocalDate value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• entity

   final V1SecFilingParams.Builder entity(String entity)

  Optional entity filter passed through to EDGAR full-text search

• entity

   final V1SecFilingParams.Builder entity(JsonField<String> entity)

  Sets Builder.entity to an arbitrary JSON value.

  You should usually call Builder.entity with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• formTypes

   final V1SecFilingParams.Builder formTypes(List<String> formTypes)

  Optional SEC form type filter such as 10-K, 10-Q, 8-K, or 4

• formTypes

   final V1SecFilingParams.Builder formTypes(JsonField<List<String>> formTypes)

  Sets Builder.formTypes to an arbitrary JSON value.

  You should usually call Builder.formTypes with a well-typed List<String> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addFormType

   final V1SecFilingParams.Builder addFormType(String formType)

  Adds a single String to formTypes.

• limit

   final V1SecFilingParams.Builder limit(Long limit)

  Maximum filings to return

• limit

   final V1SecFilingParams.Builder limit(JsonField<Long> limit)

  Sets Builder.limit to an arbitrary JSON value.

  You should usually call Builder.limit with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• offset

   final V1SecFilingParams.Builder offset(Long offset)

  Result offset for pagination

• offset

   final V1SecFilingParams.Builder offset(JsonField<Long> offset)

  Sets Builder.offset to an arbitrary JSON value.

  You should usually call Builder.offset with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• query

   final V1SecFilingParams.Builder query(String query)

  Full-text SEC search query (required for type: search)

• query

   final V1SecFilingParams.Builder query(JsonField<String> query)

  Sets Builder.query to an arbitrary JSON value.

  You should usually call Builder.query with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• ticker

   final V1SecFilingParams.Builder ticker(String ticker)

  Optional company ticker. Valid for both search and entity lookups.

• ticker

   final V1SecFilingParams.Builder ticker(JsonField<String> ticker)

  Sets Builder.ticker to an arbitrary JSON value.

  You should usually call Builder.ticker with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final V1SecFilingParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final V1SecFilingParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final V1SecFilingParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final V1SecFilingParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final V1SecFilingParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final V1SecFilingParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final V1SecFilingParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final V1SecFilingParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final V1SecFilingParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final V1SecFilingParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final V1SecFilingParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final V1SecFilingParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final V1SecFilingParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final V1SecFilingParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final V1SecFilingParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final V1SecFilingParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final V1SecFilingParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final V1SecFilingParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final V1SecFilingParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final V1SecFilingParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final V1SecFilingParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final V1SecFilingParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final V1SecFilingParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final V1SecFilingParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final V1SecFilingParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final V1SecFilingParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final V1SecFilingParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final V1SecFilingParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final V1SecFilingParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final V1SecFilingParams build()

  Returns an immutable instance of V1SecFilingParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .type()