SetQueryParameterPolicyItem¶

class oci.apigateway.models.SetQueryParameterPolicyItem(**kwargs)¶

Bases: object

Set will add a new query parameter if it was not in the original request. If the parameter already exists on the request, you can choose to override, append, or skip it.

Attributes

`IF_EXISTS_APPEND`	A constant which can be used with the if_exists property of a SetQueryParameterPolicyItem.
`IF_EXISTS_OVERWRITE`	A constant which can be used with the if_exists property of a SetQueryParameterPolicyItem.
`IF_EXISTS_SKIP`	A constant which can be used with the if_exists property of a SetQueryParameterPolicyItem.
`if_exists`	Gets the if_exists of this SetQueryParameterPolicyItem.
`name`	[Required] Gets the name of this SetQueryParameterPolicyItem.
`values`	[Required] Gets the values of this SetQueryParameterPolicyItem.

Methods

__init__(**kwargs) Initializes a new SetQueryParameterPolicyItem object with values from keyword arguments.

IF_EXISTS_APPEND = 'APPEND'¶: A constant which can be used with the if_exists property of a SetQueryParameterPolicyItem. This constant has a value of “APPEND”

IF_EXISTS_OVERWRITE = 'OVERWRITE'¶: A constant which can be used with the if_exists property of a SetQueryParameterPolicyItem. This constant has a value of “OVERWRITE”

IF_EXISTS_SKIP = 'SKIP'¶: A constant which can be used with the if_exists property of a SetQueryParameterPolicyItem. This constant has a value of “SKIP”

__init__(**kwargs)¶

Initializes a new SetQueryParameterPolicyItem object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this SetQueryParameterPolicyItem.
values (list[str]) – The value to assign to the values property of this SetQueryParameterPolicyItem.
if_exists (str) – The value to assign to the if_exists property of this SetQueryParameterPolicyItem. Allowed values for this property are: “OVERWRITE”, “APPEND”, “SKIP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

if_exists¶

Gets the if_exists of this SetQueryParameterPolicyItem. If a query parameter with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.

Allowed values for this property are: “OVERWRITE”, “APPEND”, “SKIP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The if_exists of this SetQueryParameterPolicyItem.
Return type:	str

name¶

[Required] Gets the name of this SetQueryParameterPolicyItem. The case-sensitive name of the query parameter. This name must be unique across transformation policies.

Returns:	The name of this SetQueryParameterPolicyItem.
Return type:	str

values¶

[Required] Gets the values of this SetQueryParameterPolicyItem. A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

Returns:	The values of this SetQueryParameterPolicyItem.
Return type:	list[str]