Package software.amazon.awssdk.services.apigateway.model

Class PatchOperation

java.lang.Object

software.amazon.awssdk.services.apigateway.model.PatchOperation

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<PatchOperation.Builder,PatchOperation>

@Generated("software.amazon.awssdk:codegen")
public class PatchOperation
extends Object
implements StructuredPojo, ToCopyableBuilder<PatchOperation.Builder,PatchOperation>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PatchOperation.Builder

Method Summary

Modifier and Type	Method	Description
static PatchOperation.Builder	builder()
boolean	equals(Object obj)
String	from()	Not supported.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	op()	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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

op

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

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

path

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.

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.

value

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.

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.

from

public String from()

Not supported.

Returns:

Not supported.

toBuilder

public PatchOperation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PatchOperation.Builder,PatchOperation>

Returns:

a builder for type T

builder

public static PatchOperation.Builder builder()

serializableBuilderClass

public static Class<? extends PatchOperation.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

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