ParametersPutRequestBody

pydantic model openapi_client.models.parameters_put_request_body.ParametersPutRequestBody

ParametersPutRequestBody

Fields:
field parameter_value: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=4000)]] = None (alias 'ParameterValue')

Updated parameter value (1–4000 characters). Defaults to current decrypted value when omitted.

field description: Optional[StrictStr] = None (alias 'Description')

Optional updated description. Defaults to existing description when omitted.

field parameter_managers: Optional[List[StrictStr]] = None (alias 'ParameterManagers')

Global scope only. Updated list of manager user IDs. Cannot be emptied; original creator cannot be removed. Ignored for user-scoped parameters.

field parameter_key: Optional[StrictStr] = None (alias 'ParameterKey')

Ignored on PUT — ParameterKey is taken from the path.

field parameter_type: Optional[StrictStr] = None (alias 'ParameterType')

Ignored on PUT — type cannot be changed via update.

field scope: Optional[StrictStr] = None (alias 'Scope')

Ignored on PUT — scope cannot be changed via update.

field tenant_name: Optional[StrictStr] = None (alias 'TenantName')

Ignored on PUT.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of ParametersPutRequestBody from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of ParametersPutRequestBody from a dict

Return type:

Optional[Self]