AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::PatchOperation Class Reference

#include <PatchOperation.h>

Public Member Functions

 PatchOperation ()
 
 PatchOperation (Aws::Utils::Json::JsonView jsonValue)
 
PatchOperationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const OpGetOp () const
 
bool OpHasBeenSet () const
 
void SetOp (const Op &value)
 
void SetOp (Op &&value)
 
PatchOperationWithOp (const Op &value)
 
PatchOperationWithOp (Op &&value)
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
PatchOperationWithPath (const Aws::String &value)
 
PatchOperationWithPath (Aws::String &&value)
 
PatchOperationWithPath (const char *value)
 
const Aws::StringGetValue () const
 
bool ValueHasBeenSet () const
 
void SetValue (const Aws::String &value)
 
void SetValue (Aws::String &&value)
 
void SetValue (const char *value)
 
PatchOperationWithValue (const Aws::String &value)
 
PatchOperationWithValue (Aws::String &&value)
 
PatchOperationWithValue (const char *value)
 
const Aws::StringGetFrom () const
 
bool FromHasBeenSet () const
 
void SetFrom (const Aws::String &value)
 
void SetFrom (Aws::String &&value)
 
void SetFrom (const char *value)
 
PatchOperationWithFrom (const Aws::String &value)
 
PatchOperationWithFrom (Aws::String &&value)
 
PatchOperationWithFrom (const char *value)
 

Detailed Description

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 Also:

AWS API Reference

Definition at line 34 of file PatchOperation.h.

Constructor & Destructor Documentation

◆ PatchOperation() [1/2]

Aws::APIGateway::Model::PatchOperation::PatchOperation ( )

◆ PatchOperation() [2/2]

Aws::APIGateway::Model::PatchOperation::PatchOperation ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ FromHasBeenSet()

bool Aws::APIGateway::Model::PatchOperation::FromHasBeenSet ( ) const
inline

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".

Definition at line 320 of file PatchOperation.h.

◆ GetFrom()

const Aws::String& Aws::APIGateway::Model::PatchOperation::GetFrom ( ) const
inline

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".

Definition at line 309 of file PatchOperation.h.

◆ GetOp()

const Op& Aws::APIGateway::Model::PatchOperation::GetOp ( ) const
inline

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.

Definition at line 50 of file PatchOperation.h.

◆ GetPath()

const Aws::String& Aws::APIGateway::Model::PatchOperation::GetPath ( ) const
inline

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.

Definition at line 111 of file PatchOperation.h.

◆ GetValue()

const Aws::String& Aws::APIGateway::Model::PatchOperation::GetValue ( ) const
inline

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 Using JSON for Parameters.

Definition at line 227 of file PatchOperation.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::PatchOperation::Jsonize ( ) const

◆ operator=()

PatchOperation& Aws::APIGateway::Model::PatchOperation::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OpHasBeenSet()

bool Aws::APIGateway::Model::PatchOperation::OpHasBeenSet ( ) const
inline

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.

Definition at line 59 of file PatchOperation.h.

◆ PathHasBeenSet()

bool Aws::APIGateway::Model::PatchOperation::PathHasBeenSet ( ) const
inline

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.

Definition at line 126 of file PatchOperation.h.

◆ SetFrom() [1/3]

void Aws::APIGateway::Model::PatchOperation::SetFrom ( const Aws::String value)
inline

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".

Definition at line 331 of file PatchOperation.h.

◆ SetFrom() [2/3]

void Aws::APIGateway::Model::PatchOperation::SetFrom ( Aws::String &&  value)
inline

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".

Definition at line 342 of file PatchOperation.h.

◆ SetFrom() [3/3]

void Aws::APIGateway::Model::PatchOperation::SetFrom ( const char *  value)
inline

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".

Definition at line 353 of file PatchOperation.h.

◆ SetOp() [1/2]

void Aws::APIGateway::Model::PatchOperation::SetOp ( const Op value)
inline

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.

Definition at line 68 of file PatchOperation.h.

◆ SetOp() [2/2]

void Aws::APIGateway::Model::PatchOperation::SetOp ( Op &&  value)
inline

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.

Definition at line 77 of file PatchOperation.h.

◆ SetPath() [1/3]

void Aws::APIGateway::Model::PatchOperation::SetPath ( const Aws::String value)
inline

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.

Definition at line 141 of file PatchOperation.h.

◆ SetPath() [2/3]

void Aws::APIGateway::Model::PatchOperation::SetPath ( Aws::String &&  value)
inline

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.

Definition at line 156 of file PatchOperation.h.

◆ SetPath() [3/3]

void Aws::APIGateway::Model::PatchOperation::SetPath ( const char *  value)
inline

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.

Definition at line 171 of file PatchOperation.h.

◆ SetValue() [1/3]

void Aws::APIGateway::Model::PatchOperation::SetValue ( const Aws::String value)
inline

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 Using JSON for Parameters.

Definition at line 247 of file PatchOperation.h.

◆ SetValue() [2/3]

void Aws::APIGateway::Model::PatchOperation::SetValue ( Aws::String &&  value)
inline

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 Using JSON for Parameters.

Definition at line 257 of file PatchOperation.h.

◆ SetValue() [3/3]

void Aws::APIGateway::Model::PatchOperation::SetValue ( const char *  value)
inline

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 Using JSON for Parameters.

Definition at line 267 of file PatchOperation.h.

◆ ValueHasBeenSet()

bool Aws::APIGateway::Model::PatchOperation::ValueHasBeenSet ( ) const
inline

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 Using JSON for Parameters.

Definition at line 237 of file PatchOperation.h.

◆ WithFrom() [1/3]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithFrom ( const Aws::String value)
inline

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".

Definition at line 364 of file PatchOperation.h.

◆ WithFrom() [2/3]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithFrom ( Aws::String &&  value)
inline

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".

Definition at line 375 of file PatchOperation.h.

◆ WithFrom() [3/3]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithFrom ( const char *  value)
inline

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".

Definition at line 386 of file PatchOperation.h.

◆ WithOp() [1/2]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithOp ( const Op value)
inline

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.

Definition at line 86 of file PatchOperation.h.

◆ WithOp() [2/2]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithOp ( Op &&  value)
inline

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.

Definition at line 95 of file PatchOperation.h.

◆ WithPath() [1/3]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithPath ( const Aws::String value)
inline

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.

Definition at line 186 of file PatchOperation.h.

◆ WithPath() [2/3]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithPath ( Aws::String &&  value)
inline

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.

Definition at line 201 of file PatchOperation.h.

◆ WithPath() [3/3]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithPath ( const char *  value)
inline

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.

Definition at line 216 of file PatchOperation.h.

◆ WithValue() [1/3]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithValue ( const Aws::String value)
inline

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 Using JSON for Parameters.

Definition at line 277 of file PatchOperation.h.

◆ WithValue() [2/3]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithValue ( Aws::String &&  value)
inline

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 Using JSON for Parameters.

Definition at line 287 of file PatchOperation.h.

◆ WithValue() [3/3]

PatchOperation& Aws::APIGateway::Model::PatchOperation::WithValue ( const char *  value)
inline

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 Using JSON for Parameters.

Definition at line 297 of file PatchOperation.h.


The documentation for this class was generated from the following file: