{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.APIGateway.Types.PatchOperation
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.APIGateway.Types.PatchOperation where

import Amazonka.APIGateway.Types.Op
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | For more information about supported patch operations, see
-- <https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html Patch Operations>.
--
-- /See:/ 'newPatchOperation' smart constructor.
data PatchOperation = PatchOperation'
  { -- | The copy update operation\'s source as identified by a JSON-Pointer
    -- value referencing the location within the targeted resource to copy the
    -- value from. For example, to promote a canary deployment, you copy the
    -- canary deployment ID to the affiliated deployment ID by calling a PATCH
    -- request on a Stage resource with \"op\":\"copy\",
    -- \"from\":\"\/canarySettings\/deploymentId\" and
    -- \"path\":\"\/deploymentId\".
    PatchOperation -> Maybe Text
from :: Prelude.Maybe Prelude.Text,
    -- | An update operation to be performed with this PATCH request. The valid
    -- value can be add, remove, replace or copy. Not all valid operations are
    -- supported for a given resource. Support of the operations depends on
    -- specific operational contexts. Attempts to apply an unsupported
    -- operation on a resource will return an error message..
    PatchOperation -> Maybe Op
op :: Prelude.Maybe Op,
    -- | The op operation\'s target, as identified by a JSON Pointer value that
    -- references a location within the targeted resource. For example, if the
    -- target resource has an updateable property of {\"name\":\"value\"}, the
    -- path for this property is \/name. If the name property value is a JSON
    -- object (e.g., {\"name\": {\"child\/name\": \"child-value\"}}), the path
    -- for the child\/name property will be \/name\/child~1name. Any slash
    -- (\"\/\") character appearing in path names must be escaped with \"~1\",
    -- as shown in the example above. Each op operation can have only one path
    -- associated with it.
    PatchOperation -> Maybe Text
path :: Prelude.Maybe Prelude.Text,
    -- | The new target value of the update operation. It is applicable for the
    -- add or replace operation. When using AWS CLI to update a property of a
    -- JSON value, enclose the JSON object with a pair of single quotes in a
    -- Linux shell, e.g., \'{\"a\": ...}\'.
    PatchOperation -> Maybe Text
value :: Prelude.Maybe Prelude.Text
  }
  deriving (PatchOperation -> PatchOperation -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PatchOperation -> PatchOperation -> Bool
$c/= :: PatchOperation -> PatchOperation -> Bool
== :: PatchOperation -> PatchOperation -> Bool
$c== :: PatchOperation -> PatchOperation -> Bool
Prelude.Eq, ReadPrec [PatchOperation]
ReadPrec PatchOperation
Int -> ReadS PatchOperation
ReadS [PatchOperation]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PatchOperation]
$creadListPrec :: ReadPrec [PatchOperation]
readPrec :: ReadPrec PatchOperation
$creadPrec :: ReadPrec PatchOperation
readList :: ReadS [PatchOperation]
$creadList :: ReadS [PatchOperation]
readsPrec :: Int -> ReadS PatchOperation
$creadsPrec :: Int -> ReadS PatchOperation
Prelude.Read, Int -> PatchOperation -> ShowS
[PatchOperation] -> ShowS
PatchOperation -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PatchOperation] -> ShowS
$cshowList :: [PatchOperation] -> ShowS
show :: PatchOperation -> String
$cshow :: PatchOperation -> String
showsPrec :: Int -> PatchOperation -> ShowS
$cshowsPrec :: Int -> PatchOperation -> ShowS
Prelude.Show, forall x. Rep PatchOperation x -> PatchOperation
forall x. PatchOperation -> Rep PatchOperation x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PatchOperation x -> PatchOperation
$cfrom :: forall x. PatchOperation -> Rep PatchOperation x
Prelude.Generic)

-- |
-- Create a value of 'PatchOperation' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'from', 'patchOperation_from' - The copy update operation\'s source as identified by a JSON-Pointer
-- value referencing the location within the targeted resource to copy the
-- value from. For example, to promote a canary deployment, you copy the
-- canary deployment ID to the affiliated deployment ID by calling a PATCH
-- request on a Stage resource with \"op\":\"copy\",
-- \"from\":\"\/canarySettings\/deploymentId\" and
-- \"path\":\"\/deploymentId\".
--
-- 'op', 'patchOperation_op' - An update operation to be performed with this PATCH request. The valid
-- value can be add, remove, replace or copy. Not all valid operations are
-- supported for a given resource. Support of the operations depends on
-- specific operational contexts. Attempts to apply an unsupported
-- operation on a resource will return an error message..
--
-- 'path', 'patchOperation_path' - The op operation\'s target, as identified by a JSON Pointer value that
-- references a location within the targeted resource. For example, if the
-- target resource has an updateable property of {\"name\":\"value\"}, the
-- path for this property is \/name. If the name property value is a JSON
-- object (e.g., {\"name\": {\"child\/name\": \"child-value\"}}), the path
-- for the child\/name property will be \/name\/child~1name. Any slash
-- (\"\/\") character appearing in path names must be escaped with \"~1\",
-- as shown in the example above. Each op operation can have only one path
-- associated with it.
--
-- 'value', 'patchOperation_value' - The new target value of the update operation. It is applicable for the
-- add or replace operation. When using AWS CLI to update a property of a
-- JSON value, enclose the JSON object with a pair of single quotes in a
-- Linux shell, e.g., \'{\"a\": ...}\'.
newPatchOperation ::
  PatchOperation
newPatchOperation :: PatchOperation
newPatchOperation =
  PatchOperation'
    { $sel:from:PatchOperation' :: Maybe Text
from = forall a. Maybe a
Prelude.Nothing,
      $sel:op:PatchOperation' :: Maybe Op
op = forall a. Maybe a
Prelude.Nothing,
      $sel:path:PatchOperation' :: Maybe Text
path = forall a. Maybe a
Prelude.Nothing,
      $sel:value:PatchOperation' :: Maybe Text
value = forall a. Maybe a
Prelude.Nothing
    }

-- | The copy update operation\'s source as identified by a JSON-Pointer
-- value referencing the location within the targeted resource to copy the
-- value from. For example, to promote a canary deployment, you copy the
-- canary deployment ID to the affiliated deployment ID by calling a PATCH
-- request on a Stage resource with \"op\":\"copy\",
-- \"from\":\"\/canarySettings\/deploymentId\" and
-- \"path\":\"\/deploymentId\".
patchOperation_from :: Lens.Lens' PatchOperation (Prelude.Maybe Prelude.Text)
patchOperation_from :: Lens' PatchOperation (Maybe Text)
patchOperation_from = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PatchOperation' {Maybe Text
from :: Maybe Text
$sel:from:PatchOperation' :: PatchOperation -> Maybe Text
from} -> Maybe Text
from) (\s :: PatchOperation
s@PatchOperation' {} Maybe Text
a -> PatchOperation
s {$sel:from:PatchOperation' :: Maybe Text
from = Maybe Text
a} :: PatchOperation)

-- | An update operation to be performed with this PATCH request. The valid
-- value can be add, remove, replace or copy. Not all valid operations are
-- supported for a given resource. Support of the operations depends on
-- specific operational contexts. Attempts to apply an unsupported
-- operation on a resource will return an error message..
patchOperation_op :: Lens.Lens' PatchOperation (Prelude.Maybe Op)
patchOperation_op :: Lens' PatchOperation (Maybe Op)
patchOperation_op = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PatchOperation' {Maybe Op
op :: Maybe Op
$sel:op:PatchOperation' :: PatchOperation -> Maybe Op
op} -> Maybe Op
op) (\s :: PatchOperation
s@PatchOperation' {} Maybe Op
a -> PatchOperation
s {$sel:op:PatchOperation' :: Maybe Op
op = Maybe Op
a} :: PatchOperation)

-- | The op operation\'s target, as identified by a JSON Pointer value that
-- references a location within the targeted resource. For example, if the
-- target resource has an updateable property of {\"name\":\"value\"}, the
-- path for this property is \/name. If the name property value is a JSON
-- object (e.g., {\"name\": {\"child\/name\": \"child-value\"}}), the path
-- for the child\/name property will be \/name\/child~1name. Any slash
-- (\"\/\") character appearing in path names must be escaped with \"~1\",
-- as shown in the example above. Each op operation can have only one path
-- associated with it.
patchOperation_path :: Lens.Lens' PatchOperation (Prelude.Maybe Prelude.Text)
patchOperation_path :: Lens' PatchOperation (Maybe Text)
patchOperation_path = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PatchOperation' {Maybe Text
path :: Maybe Text
$sel:path:PatchOperation' :: PatchOperation -> Maybe Text
path} -> Maybe Text
path) (\s :: PatchOperation
s@PatchOperation' {} Maybe Text
a -> PatchOperation
s {$sel:path:PatchOperation' :: Maybe Text
path = Maybe Text
a} :: PatchOperation)

-- | The new target value of the update operation. It is applicable for the
-- add or replace operation. When using AWS CLI to update a property of a
-- JSON value, enclose the JSON object with a pair of single quotes in a
-- Linux shell, e.g., \'{\"a\": ...}\'.
patchOperation_value :: Lens.Lens' PatchOperation (Prelude.Maybe Prelude.Text)
patchOperation_value :: Lens' PatchOperation (Maybe Text)
patchOperation_value = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PatchOperation' {Maybe Text
value :: Maybe Text
$sel:value:PatchOperation' :: PatchOperation -> Maybe Text
value} -> Maybe Text
value) (\s :: PatchOperation
s@PatchOperation' {} Maybe Text
a -> PatchOperation
s {$sel:value:PatchOperation' :: Maybe Text
value = Maybe Text
a} :: PatchOperation)

instance Prelude.Hashable PatchOperation where
  hashWithSalt :: Int -> PatchOperation -> Int
hashWithSalt Int
_salt PatchOperation' {Maybe Text
Maybe Op
value :: Maybe Text
path :: Maybe Text
op :: Maybe Op
from :: Maybe Text
$sel:value:PatchOperation' :: PatchOperation -> Maybe Text
$sel:path:PatchOperation' :: PatchOperation -> Maybe Text
$sel:op:PatchOperation' :: PatchOperation -> Maybe Op
$sel:from:PatchOperation' :: PatchOperation -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
from
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Op
op
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
path
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
value

instance Prelude.NFData PatchOperation where
  rnf :: PatchOperation -> ()
rnf PatchOperation' {Maybe Text
Maybe Op
value :: Maybe Text
path :: Maybe Text
op :: Maybe Op
from :: Maybe Text
$sel:value:PatchOperation' :: PatchOperation -> Maybe Text
$sel:path:PatchOperation' :: PatchOperation -> Maybe Text
$sel:op:PatchOperation' :: PatchOperation -> Maybe Op
$sel:from:PatchOperation' :: PatchOperation -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
from
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Op
op
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
path
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
value

instance Data.ToJSON PatchOperation where
  toJSON :: PatchOperation -> Value
toJSON PatchOperation' {Maybe Text
Maybe Op
value :: Maybe Text
path :: Maybe Text
op :: Maybe Op
from :: Maybe Text
$sel:value:PatchOperation' :: PatchOperation -> Maybe Text
$sel:path:PatchOperation' :: PatchOperation -> Maybe Text
$sel:op:PatchOperation' :: PatchOperation -> Maybe Op
$sel:from:PatchOperation' :: PatchOperation -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"from" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
from,
            (Key
"op" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Op
op,
            (Key
"path" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
path,
            (Key
"value" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
value
          ]
      )