Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
Documentation
data DocumentInfo Source #
Identifies a document for which to retrieve status information
See: newDocumentInfo
smart constructor.
DocumentInfo' | |
|
Instances
Create a value of DocumentInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:DocumentInfo'
, documentInfo_attributes
- Attributes that identify a specific version of a document to check.
The only valid attributes are:
- version
- datasourceId
- jobExecutionId
The attributes follow these rules:
dataSourceId
andjobExecutionId
must be used together.version
is ignored ifdataSourceId
andjobExecutionId
are not provided.- If
dataSourceId
andjobExecutionId
are provided, butversion
is not, the version defaults to "0".
$sel:documentId:DocumentInfo'
, documentInfo_documentId
- The identifier of the document.
documentInfo_attributes :: Lens' DocumentInfo (Maybe [DocumentAttribute]) Source #
Attributes that identify a specific version of a document to check.
The only valid attributes are:
- version
- datasourceId
- jobExecutionId
The attributes follow these rules:
dataSourceId
andjobExecutionId
must be used together.version
is ignored ifdataSourceId
andjobExecutionId
are not provided.- If
dataSourceId
andjobExecutionId
are provided, butversion
is not, the version defaults to "0".
documentInfo_documentId :: Lens' DocumentInfo Text Source #
The identifier of the document.