@Generated(value="software.amazon.awssdk:codegen") public final class PatchOperation extends Object implements StructuredPojo, ToCopyableBuilder<PatchOperation.Builder,PatchOperation>
Modifier and Type | Class and Description |
---|---|
static interface |
PatchOperation.Builder |
Modifier and Type | Method and Description |
---|---|
static PatchOperation.Builder |
builder() |
boolean |
equals(Object obj) |
String |
from()
Not supported.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Op |
op()
An update operation to be performed with this PATCH request.
|
String |
opAsString()
An update operation to be performed with this PATCH request.
|
String |
path()
The
op operation's target, as identified by a JSON Pointer value that references a
location within the targeted resource. |
static Class<? extends PatchOperation.Builder> |
serializableBuilderClass() |
PatchOperation.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
value()
The new target value of the update operation.
|
copy
public 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.
If the service returns an enum value that is not available in the current SDK version, op
will return
Op.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from opAsString()
.
Op
public String opAsString()
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.
If the service returns an enum value that is not available in the current SDK version, op
will return
Op.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from opAsString()
.
Op
public 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.
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.public 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.
public String from()
Not supported.
public PatchOperation.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PatchOperation.Builder,PatchOperation>
public static PatchOperation.Builder builder()
public static Class<? extends PatchOperation.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.