software.amazon.awssdk.services.apigateway.model

Interface PatchOperation.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PatchOperation.Builder,PatchOperation>, SdkBuilder<PatchOperation.Builder,PatchOperation>, SdkPojo

Enclosing class:

PatchOperation

public static interface PatchOperation.Builder
extends SdkPojo, CopyableBuilder<PatchOperation.Builder,PatchOperation>

Method Summary

Modifier and Type	Method and Description
PatchOperation.Builder	from(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.
PatchOperation.Builder	op(Op op) An update operation to be performed with this PATCH request.
PatchOperation.Builder	op(String op) An update operation to be performed with this PATCH request.
PatchOperation.Builder	path(String path) The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource.
PatchOperation.Builder	value(String value) The new target value of the update operation.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

op

PatchOperation.Builder op(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Op, Op

op

PatchOperation.Builder op(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Op, Op

path

PatchOperation.Builder path(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.

value

PatchOperation.Builder value(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

from

PatchOperation.Builder from(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".

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.