Parameter

class oci.resource_scheduler.models.Parameter(**kwargs)

Bases: object

This is a generic input parameter to use when acting on the resource.

Attributes

PARAMETER_TYPE_BODY A constant which can be used with the parameter_type property of a Parameter.
PARAMETER_TYPE_HEADER A constant which can be used with the parameter_type property of a Parameter.
PARAMETER_TYPE_PATH A constant which can be used with the parameter_type property of a Parameter.
PARAMETER_TYPE_QUERY A constant which can be used with the parameter_type property of a Parameter.
parameter_type [Required] Gets the parameter_type of this Parameter.

Methods

__init__(**kwargs) Initializes a new Parameter 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.
PARAMETER_TYPE_BODY = 'BODY'

A constant which can be used with the parameter_type property of a Parameter. This constant has a value of “BODY”

PARAMETER_TYPE_HEADER = 'HEADER'

A constant which can be used with the parameter_type property of a Parameter. This constant has a value of “HEADER”

PARAMETER_TYPE_PATH = 'PATH'

A constant which can be used with the parameter_type property of a Parameter. This constant has a value of “PATH”

PARAMETER_TYPE_QUERY = 'QUERY'

A constant which can be used with the parameter_type property of a Parameter. This constant has a value of “QUERY”

__init__(**kwargs)

Initializes a new Parameter object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:parameter_type (str) – The value to assign to the parameter_type property of this Parameter. Allowed values for this property are: “HEADER”, “BODY”, “PATH”, “QUERY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
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.

parameter_type

[Required] Gets the parameter_type of this Parameter. This is the parameter type on which the input parameter is defined

Allowed values for this property are: “HEADER”, “BODY”, “PATH”, “QUERY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The parameter_type of this Parameter.
Return type:str