@Generated(value="software.amazon.awssdk:codegen") public final class PatchOperation extends Object implements SdkPojo, Serializable, 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) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
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. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
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. |
List<SdkField<?>> |
sdkFields() |
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()
Returns a string representation of this object.
|
String |
value()
The new target value of the update operation.
|
copypublic final Op 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.
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().
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.Oppublic final String opAsString()
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.
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().
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.Oppublic final 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 final String 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 Using JSON for
Parameters.
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.public final String 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".
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".public PatchOperation.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<PatchOperation.Builder,PatchOperation>public static PatchOperation.Builder builder()
public static Class<? extends PatchOperation.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()