SdkLanguageOptionalParameters

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

Bases: object

List of additional applicable parameters for any given target language.

Attributes:

INPUT_TYPE_EMAIL

A constant which can be used with the input_type property of a SdkLanguageOptionalParameters.

INPUT_TYPE_ENUM

A constant which can be used with the input_type property of a SdkLanguageOptionalParameters.

INPUT_TYPE_STRING

A constant which can be used with the input_type property of a SdkLanguageOptionalParameters.

INPUT_TYPE_URI

A constant which can be used with the input_type property of a SdkLanguageOptionalParameters.

allowed_values

Gets the allowed_values of this SdkLanguageOptionalParameters.

description

Gets the description of this SdkLanguageOptionalParameters.

display_name

Gets the display_name of this SdkLanguageOptionalParameters.

input_type

Gets the input_type of this SdkLanguageOptionalParameters.

is_required

Gets the is_required of this SdkLanguageOptionalParameters.

max_size

Gets the max_size of this SdkLanguageOptionalParameters.

param_name

[Required] Gets the param_name of this SdkLanguageOptionalParameters.

Methods:

__init__(**kwargs)

Initializes a new SdkLanguageOptionalParameters object with values from keyword arguments.

INPUT_TYPE_EMAIL = 'EMAIL'

A constant which can be used with the input_type property of a SdkLanguageOptionalParameters. This constant has a value of “EMAIL”

INPUT_TYPE_ENUM = 'ENUM'

A constant which can be used with the input_type property of a SdkLanguageOptionalParameters. This constant has a value of “ENUM”

INPUT_TYPE_STRING = 'STRING'

A constant which can be used with the input_type property of a SdkLanguageOptionalParameters. This constant has a value of “STRING”

INPUT_TYPE_URI = 'URI'

A constant which can be used with the input_type property of a SdkLanguageOptionalParameters. This constant has a value of “URI”

__init__(**kwargs)

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

Parameters
  • param_name (str) – The value to assign to the param_name property of this SdkLanguageOptionalParameters.

  • display_name (str) – The value to assign to the display_name property of this SdkLanguageOptionalParameters.

  • description (str) – The value to assign to the description property of this SdkLanguageOptionalParameters.

  • is_required (bool) – The value to assign to the is_required property of this SdkLanguageOptionalParameters.

  • max_size (float) – The value to assign to the max_size property of this SdkLanguageOptionalParameters.

  • input_type (str) – The value to assign to the input_type property of this SdkLanguageOptionalParameters. Allowed values for this property are: “ENUM”, “EMAIL”, “URI”, “STRING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • allowed_values (list[oci.apigateway.models.SdkLanguageOptionalParametersAllowedValue]) – The value to assign to the allowed_values property of this SdkLanguageOptionalParameters.

property allowed_values

Gets the allowed_values of this SdkLanguageOptionalParameters. List of allowed input values. Example: [{“name”: “name1”, “description”: “description1”}, …]

Returns

The allowed_values of this SdkLanguageOptionalParameters.

Return type

list[oci.apigateway.models.SdkLanguageOptionalParametersAllowedValue]

property description

Gets the description of this SdkLanguageOptionalParameters. Description for the parameter.

Returns

The description of this SdkLanguageOptionalParameters.

Return type

str

property display_name

Gets the display_name of this SdkLanguageOptionalParameters. Display name of the parameter.

Returns

The display_name of this SdkLanguageOptionalParameters.

Return type

str

property input_type

Gets the input_type of this SdkLanguageOptionalParameters. The input type for this param. - Input type is ENUM when only specific list of input strings are allowed. - Input type is EMAIL when input type is an email ID. - Input type is URI when input type is an URI. - Input type is STRING in all other cases.

Allowed values for this property are: “ENUM”, “EMAIL”, “URI”, “STRING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The input_type of this SdkLanguageOptionalParameters.

Return type

str

property is_required

Gets the is_required of this SdkLanguageOptionalParameters. Information on whether the parameter is required or not.

Returns

The is_required of this SdkLanguageOptionalParameters.

Return type

bool

property max_size

Gets the max_size of this SdkLanguageOptionalParameters. Maximum size as input value for this parameter.

Returns

The max_size of this SdkLanguageOptionalParameters.

Return type

float

property param_name

[Required] Gets the param_name of this SdkLanguageOptionalParameters. Name of the parameter.

Returns

The param_name of this SdkLanguageOptionalParameters.

Return type

str