PatchInsertInstruction¶

class oci.capacity_management.models.PatchInsertInstruction(**kwargs)¶

Bases: oci.capacity_management.models.patch_instruction.PatchInstruction

An operation that inserts a value into an array, shifting array items as necessary and handling NOT_FOUND exceptions by creating the implied containing structure.

Attributes

`OPERATION_INSERT`	str(object=’’) -> str
`OPERATION_MERGE`	str(object=’’) -> str
`OPERATION_MOVE`	str(object=’’) -> str
`OPERATION_PROHIBIT`	str(object=’’) -> str
`OPERATION_REMOVE`	str(object=’’) -> str
`OPERATION_REPLACE`	str(object=’’) -> str
`OPERATION_REQUIRE`	str(object=’’) -> str
`POSITION_AFTER`	A constant which can be used with the position property of a PatchInsertInstruction.
`POSITION_BEFORE`	A constant which can be used with the position property of a PatchInsertInstruction.
`operation`	[Required] Gets the operation of this PatchInstruction.
`position`	Gets the position of this PatchInsertInstruction.
`selected_item`	Gets the selected_item of this PatchInsertInstruction.
`selection`	[Required] Gets the selection of this PatchInstruction.
`value`	[Required] Gets the value of this PatchInsertInstruction.

Methods

`__init__`(**kwargs)	Initializes a new PatchInsertInstruction object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

OPERATION_INSERT = 'INSERT'¶

OPERATION_MERGE = 'MERGE'¶

OPERATION_MOVE = 'MOVE'¶

OPERATION_PROHIBIT = 'PROHIBIT'¶

OPERATION_REMOVE = 'REMOVE'¶

OPERATION_REPLACE = 'REPLACE'¶

OPERATION_REQUIRE = 'REQUIRE'¶

POSITION_AFTER = 'AFTER'¶: A constant which can be used with the position property of a PatchInsertInstruction. This constant has a value of “AFTER”

POSITION_BEFORE = 'BEFORE'¶: A constant which can be used with the position property of a PatchInsertInstruction. This constant has a value of “BEFORE”

__init__(**kwargs)¶

Initializes a new PatchInsertInstruction object with values from keyword arguments. The default value of the operation attribute of this class is INSERT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

operation (str) – The value to assign to the operation property of this PatchInsertInstruction. Allowed values for this property are: “REQUIRE”, “PROHIBIT”, “REPLACE”, “INSERT”, “REMOVE”, “MOVE”, “MERGE”
selection (str) – The value to assign to the selection property of this PatchInsertInstruction.
value (object) – The value to assign to the value property of this PatchInsertInstruction.
selected_item (str) – The value to assign to the selected_item property of this PatchInsertInstruction.
position (str) – The value to assign to the position property of this PatchInsertInstruction. Allowed values for this property are: “BEFORE”, “AFTER”

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

operation¶

[Required] Gets the operation of this PatchInstruction. Allowed values for this property are: “REQUIRE”, “PROHIBIT”, “REPLACE”, “INSERT”, “REMOVE”, “MOVE”, “MERGE”

Returns:	The operation of this PatchInstruction.
Return type:	str

position¶

Gets the position of this PatchInsertInstruction. Where to insert the value, relative to the first item matched by selectedItem. If selectedItem is unspecified, then “BEFORE” specifies insertion at the first position in an array and “AFTER” specifies insertion at the last position. If selectedItem is specified but results in an empty selection, then both values specify insertion at the last position.

Allowed values for this property are: “BEFORE”, “AFTER”

Returns:	The position of this PatchInsertInstruction.
Return type:	str

selected_item¶

Gets the selected_item of this PatchInsertInstruction. A selection to be evaluated against the array for identifying a particular reference item within it, with the same format and semantics as selection.

Returns:	The selected_item of this PatchInsertInstruction.
Return type:	str

selection¶

[Required] Gets the selection of this PatchInstruction. The set of values to which the operation applies as a JMESPath expression for evaluation against the context resource. An operation fails if the selection yields an exception, except as otherwise specified. Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.

Returns:	The selection of this PatchInstruction.
Return type:	str

value¶

[Required] Gets the value of this PatchInsertInstruction. A value to be inserted into the target.

Returns:	The value of this PatchInsertInstruction.
Return type:	object