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 |
Updates an entity.
Synopsis
- data UpdateEntity = UpdateEntity' {}
- newUpdateEntity :: Text -> Text -> UpdateEntity
- updateEntity_componentUpdates :: Lens' UpdateEntity (Maybe (HashMap Text ComponentUpdateRequest))
- updateEntity_description :: Lens' UpdateEntity (Maybe Text)
- updateEntity_entityName :: Lens' UpdateEntity (Maybe Text)
- updateEntity_parentEntityUpdate :: Lens' UpdateEntity (Maybe ParentEntityUpdateRequest)
- updateEntity_workspaceId :: Lens' UpdateEntity Text
- updateEntity_entityId :: Lens' UpdateEntity Text
- data UpdateEntityResponse = UpdateEntityResponse' {
- httpStatus :: Int
- updateDateTime :: POSIX
- state :: State
- newUpdateEntityResponse :: Int -> UTCTime -> State -> UpdateEntityResponse
- updateEntityResponse_httpStatus :: Lens' UpdateEntityResponse Int
- updateEntityResponse_updateDateTime :: Lens' UpdateEntityResponse UTCTime
- updateEntityResponse_state :: Lens' UpdateEntityResponse State
Creating a Request
data UpdateEntity Source #
See: newUpdateEntity
smart constructor.
UpdateEntity' | |
|
Instances
Create a value of UpdateEntity
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:componentUpdates:UpdateEntity'
, updateEntity_componentUpdates
- An object that maps strings to the component updates in the request.
Each string in the mapping must be unique to this object.
UpdateEntity
, updateEntity_description
- The description of the entity.
UpdateEntity
, updateEntity_entityName
- The name of the entity.
$sel:parentEntityUpdate:UpdateEntity'
, updateEntity_parentEntityUpdate
- An object that describes the update request for a parent entity.
UpdateEntity
, updateEntity_workspaceId
- The ID of the workspace that contains the entity.
UpdateEntity
, updateEntity_entityId
- The ID of the entity.
Request Lenses
updateEntity_componentUpdates :: Lens' UpdateEntity (Maybe (HashMap Text ComponentUpdateRequest)) Source #
An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.
updateEntity_description :: Lens' UpdateEntity (Maybe Text) Source #
The description of the entity.
updateEntity_entityName :: Lens' UpdateEntity (Maybe Text) Source #
The name of the entity.
updateEntity_parentEntityUpdate :: Lens' UpdateEntity (Maybe ParentEntityUpdateRequest) Source #
An object that describes the update request for a parent entity.
updateEntity_workspaceId :: Lens' UpdateEntity Text Source #
The ID of the workspace that contains the entity.
updateEntity_entityId :: Lens' UpdateEntity Text Source #
The ID of the entity.
Destructuring the Response
data UpdateEntityResponse Source #
See: newUpdateEntityResponse
smart constructor.
UpdateEntityResponse' | |
|
Instances
newUpdateEntityResponse Source #
:: Int | |
-> UTCTime | |
-> State | |
-> UpdateEntityResponse |
Create a value of UpdateEntityResponse
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:httpStatus:UpdateEntityResponse'
, updateEntityResponse_httpStatus
- The response's http status code.
UpdateEntityResponse
, updateEntityResponse_updateDateTime
- The date and time when the entity was last updated.
UpdateEntityResponse
, updateEntityResponse_state
- The current state of the entity update.
Response Lenses
updateEntityResponse_httpStatus :: Lens' UpdateEntityResponse Int Source #
The response's http status code.
updateEntityResponse_updateDateTime :: Lens' UpdateEntityResponse UTCTime Source #
The date and time when the entity was last updated.
updateEntityResponse_state :: Lens' UpdateEntityResponse State Source #
The current state of the entity update.