software.amazon.awssdk.services.apigateway.model

Class PatchOperation

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PatchOperation.Builder,PatchOperation>

@Generated(value="software.amazon.awssdk:codegen")
public final class PatchOperation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PatchOperation.Builder,PatchOperation>

For more information about supported patch operations, see Patch Operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PatchOperation.Builder

Method Summary

Modifier and Type	Method and Description
static PatchOperation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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()
String	toString() Returns a string representation of this object.
String	value() The new target value of the update operation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

op

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

Returns:

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

See Also:

Op

opAsString

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

Returns:

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

See Also:

Op

path

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

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 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": ...}'.

Returns:

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": ...}'.

from

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

Returns:

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

toBuilder

public PatchOperation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PatchOperation.Builder,PatchOperation>

builder

public static PatchOperation.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo