{-# 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-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- 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.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | A single patch operation to apply to the specified resource. Please
-- refer to http:\/\/tools.ietf.org\/html\/rfc6902#section-4 for an
-- explanation of how each operation is used.
--
-- /See:/ 'newPatchOperation' smart constructor.
data PatchOperation = 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 -> Maybe Op
op :: Prelude.Maybe Op,
    -- | The @op@ operation\'s target, as identified by a
    -- <https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08 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\": ...}\'. In a Windows shell, see
    -- <https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json Using JSON for Parameters>.
    PatchOperation -> Maybe Text
value :: Prelude.Maybe Prelude.Text,
    -- | 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
  }
  deriving (PatchOperation -> PatchOperation -> Bool
(PatchOperation -> PatchOperation -> Bool)
-> (PatchOperation -> PatchOperation -> Bool) -> Eq PatchOperation
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]
(Int -> ReadS PatchOperation)
-> ReadS [PatchOperation]
-> ReadPrec PatchOperation
-> ReadPrec [PatchOperation]
-> Read 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
(Int -> PatchOperation -> ShowS)
-> (PatchOperation -> String)
-> ([PatchOperation] -> ShowS)
-> Show PatchOperation
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. PatchOperation -> Rep PatchOperation x)
-> (forall x. Rep PatchOperation x -> PatchOperation)
-> Generic PatchOperation
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:
--
-- '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
-- <https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08 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\": ...}\'. In a Windows shell, see
-- <https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json Using JSON for Parameters>.
--
-- '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\"@.
newPatchOperation ::
  PatchOperation
newPatchOperation :: PatchOperation
newPatchOperation =
  PatchOperation' :: Maybe Op
-> Maybe Text -> Maybe Text -> Maybe Text -> PatchOperation
PatchOperation'
    { $sel:op:PatchOperation' :: Maybe Op
op = Maybe Op
forall a. Maybe a
Prelude.Nothing,
      $sel:path:PatchOperation' :: Maybe Text
path = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:value:PatchOperation' :: Maybe Text
value = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:from:PatchOperation' :: Maybe Text
from = Maybe Text
forall a. Maybe a
Prelude.Nothing
    }

-- | 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 :: (Maybe Op -> f (Maybe Op)) -> PatchOperation -> f PatchOperation
patchOperation_op = (PatchOperation -> Maybe Op)
-> (PatchOperation -> Maybe Op -> PatchOperation)
-> Lens PatchOperation PatchOperation (Maybe Op) (Maybe 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
-- <https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08 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 :: (Maybe Text -> f (Maybe Text))
-> PatchOperation -> f PatchOperation
patchOperation_path = (PatchOperation -> Maybe Text)
-> (PatchOperation -> Maybe Text -> PatchOperation)
-> Lens PatchOperation PatchOperation (Maybe Text) (Maybe Text)
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\": ...}\'. In a Windows shell, see
-- <https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json Using JSON for Parameters>.
patchOperation_value :: Lens.Lens' PatchOperation (Prelude.Maybe Prelude.Text)
patchOperation_value :: (Maybe Text -> f (Maybe Text))
-> PatchOperation -> f PatchOperation
patchOperation_value = (PatchOperation -> Maybe Text)
-> (PatchOperation -> Maybe Text -> PatchOperation)
-> Lens PatchOperation PatchOperation (Maybe Text) (Maybe Text)
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)

-- | 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 :: (Maybe Text -> f (Maybe Text))
-> PatchOperation -> f PatchOperation
patchOperation_from = (PatchOperation -> Maybe Text)
-> (PatchOperation -> Maybe Text -> PatchOperation)
-> Lens PatchOperation PatchOperation (Maybe Text) (Maybe Text)
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)

instance Prelude.Hashable PatchOperation

instance Prelude.NFData PatchOperation

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