SetHeaderPolicyItem

class oci.apigateway.models.SetHeaderPolicyItem(**kwargs)

Bases: object

Set will add a new header if it was not in the original request. If the header 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 SetHeaderPolicyItem.

IF_EXISTS_OVERWRITE

A constant which can be used with the if_exists property of a SetHeaderPolicyItem.

IF_EXISTS_SKIP

A constant which can be used with the if_exists property of a SetHeaderPolicyItem.

if_exists

Gets the if_exists of this SetHeaderPolicyItem.

name

[Required] Gets the name of this SetHeaderPolicyItem.

values

[Required] Gets the values of this SetHeaderPolicyItem.

Methods:

__init__(**kwargs)

Initializes a new SetHeaderPolicyItem object with values from keyword arguments.

IF_EXISTS_APPEND = 'APPEND'

A constant which can be used with the if_exists property of a SetHeaderPolicyItem. This constant has a value of “APPEND”

IF_EXISTS_OVERWRITE = 'OVERWRITE'

A constant which can be used with the if_exists property of a SetHeaderPolicyItem. This constant has a value of “OVERWRITE”

IF_EXISTS_SKIP = 'SKIP'

A constant which can be used with the if_exists property of a SetHeaderPolicyItem. This constant has a value of “SKIP”

__init__(**kwargs)

Initializes a new SetHeaderPolicyItem 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 SetHeaderPolicyItem.

  • values (list[str]) – The value to assign to the values property of this SetHeaderPolicyItem.

  • if_exists (str) – The value to assign to the if_exists property of this SetHeaderPolicyItem. 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’.

property if_exists

Gets the if_exists of this SetHeaderPolicyItem. If a header 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 SetHeaderPolicyItem.

Return type

str

property name

[Required] Gets the name of this SetHeaderPolicyItem. The case-insensitive name of the header. This name must be unique across transformation policies.

Returns

The name of this SetHeaderPolicyItem.

Return type

str

property values

[Required] Gets the values of this SetHeaderPolicyItem. 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 SetHeaderPolicyItem.

Return type

list[str]