PatchOperation (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.PatchOperation

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PatchOperation
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PatchOperation()

Constructors
Constructor and Description
`PatchOperation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PatchOperation`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getFrom()` Not supported.
`String`	`getOp()` An update operation to be performed with this PATCH request.
`String`	`getPath()` The `op` operation's target, as identified by a JSON Pointer value that references a location within the targeted resource.
`String`	`getValue()` The new target value of the update operation.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFrom(String from)` Not supported.
`void`	`setOp(Op op)` An update operation to be performed with this PATCH request.
`void`	`setOp(String op)` An update operation to be performed with this PATCH request.
`void`	`setPath(String path)` The `op` operation's target, as identified by a JSON Pointer value that references a location within the targeted resource.
`void`	`setValue(String value)` The new target value of the update operation.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PatchOperation`	`withFrom(String from)` Not supported.
`PatchOperation`	`withOp(Op op)` An update operation to be performed with this PATCH request.
`PatchOperation`	`withOp(String op)` An update operation to be performed with this PATCH request.
`PatchOperation`	`withPath(String path)` The `op` operation's target, as identified by a JSON Pointer value that references a location within the targeted resource.
`PatchOperation`	`withValue(String value)` The new target value of the update operation.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PatchOperation
```
public PatchOperation()
```
- Method Detail
  - setOp
```
public void setOp(String op)
```
    An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". 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.
    
    Parameters:
    
    op - An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". 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.
    
    See Also:
    
    Op
  - getOp
```
public String getOp()
```
    An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". 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.
    
    Returns:
    
    An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". 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.
    
    See Also:
    
    Op
  - withOp
```
public PatchOperation withOp(String op)
```
    An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". 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.
    
    Parameters:
    
    op - An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Op
  - setOp
```
public void setOp(Op op)
```
    An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". 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.
    
    Parameters:
    
    op - An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". 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.
    
    See Also:
    
    Op
  - withOp
```
public PatchOperation withOp(Op op)
```
    An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". 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.
    
    Parameters:
    
    op - An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Op
  - setPath
```
public void setPath(String 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.
    
    Parameters:
    
    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.
  - getPath
```
public String getPath()
```
    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.
    
    Returns:
    
    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.
  - withPath
```
public PatchOperation withPath(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValue
```
public void setValue(String value)
```
    The new target value of the update 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.
    
    Parameters:
    
    value - The new target value of the update 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.
  - getValue
```
public String getValue()
```
    The new target value of the update 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.
    
    Returns:
    
    The new target value of the update 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.
  - withValue
```
public PatchOperation withValue(String value)
```
    The new target value of the update 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.
    
    Parameters:
    
    value - The new target value of the update 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFrom
```
public void setFrom(String from)
```
    Not supported.
    
    Parameters:
    
    from - Not supported.
  - getFrom
```
public String getFrom()
```
    Not supported.
    
    Returns:
    
    Not supported.
  - withFrom
```
public PatchOperation withFrom(String from)
```
    Not supported.
    
    Parameters:
    
    from - Not supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PatchOperation clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PatchOperation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PatchOperation

Method Detail

setOp

getOp

withOp

setOp

withOp

setPath

getPath

withPath

setValue

getValue

withValue

setFrom

getFrom

withFrom

toString

equals

hashCode

clone

marshall