class Vellum::DocumentDocumentToDocumentIndex

def self.from_json(json_object:)

Returns:
  • (DocumentDocumentToDocumentIndex) -

Parameters:
  • json_object (JSON) --
def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = struct.id
  document_index_id = struct.document_index_id
  indexing_state = INDEXING_STATE_ENUM.key(parsed_json["indexing_state"]) || parsed_json["indexing_state"]
  new(id: id, document_index_id: document_index_id, indexing_state: indexing_state, additional_properties: struct)
end

def self.validate_raw(obj:)

Returns:
  • (Void) -

Parameters:
  • obj (Object) --
def self.validate_raw(obj:)
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.document_index_id.is_a?(String) != false || raise("Passed value for field obj.document_index_id is not the expected type, validation failed.")
  obj.indexing_state&.is_a?(INDEXING_STATE_ENUM) != false || raise("Passed value for field obj.indexing_state is not the expected type, validation failed.")
end

def initialize(id:, document_index_id:, indexing_state: nil, additional_properties: nil)

Returns:
  • (DocumentDocumentToDocumentIndex) -

Parameters:
  • additional_properties (OpenStruct) -- Additional properties unmapped to the current class definition
  • indexing_state (INDEXING_STATE_ENUM) -- An enum value representing where this document is along its indexing lifecycle for this index.
  • document_index_id (String) -- Vellum-generated ID that uniquely identifies the index this document is included in.
  • id (String) -- Vellum-generated ID that uniquely identifies this link.
def initialize(id:, document_index_id:, indexing_state: nil, additional_properties: nil)
  # @type [String] Vellum-generated ID that uniquely identifies this link.
  @id = id
  # @type [String] Vellum-generated ID that uniquely identifies the index this document is included in.
  @document_index_id = document_index_id
  # @type [INDEXING_STATE_ENUM] An enum value representing where this document is along its indexing lifecycle for this index.
  #   - `AWAITING_PROCESSING` - Awaiting Processing
  #   - `QUEUED` - Queued
  #   - `INDEXING` - Indexing
  #   - `INDEXED` - Indexed
  #   - `FAILED` - Failed
  @indexing_state = indexing_state
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

def to_json(*_args)

Returns:
  • (JSON) -
def to_json(*_args)
  {
    "id": @id,
    "document_index_id": @document_index_id,
    "indexing_state": INDEXING_STATE_ENUM[@indexing_state] || @indexing_state
  }.to_json
end