class documentation
class DeprecationDetails(pb_classes.Message): (source)
Constructor: DeprecationDetails(initial_message, effective_at, description, description_cli)
Undocumented
| Method | __dir__ |
Undocumented |
| Method | __init__ |
Create a wrapper around a protobuf message instance. |
| Method | description |
Undocumented |
| Method | description |
Undocumented |
| Method | effective |
Undocumented |
| Constant | __PB2 |
Undocumented |
| Constant | __PY |
Undocumented |
| Class Variable | __mask |
Undocumented |
| Property | description |
A description to help users understand the reason for deprecation and suggest alternatives. By default, this message will be shown in the CLI, Terraform, and SDKs as is. |
| Property | description |
Override base description for CLI, specify possible alternative method Example: "Please use the 'iam v2 access-key' command instead. All existing keys remain accessible through the new command." |
| Property | effective |
The date when this method, service, message or field will stop working (format: YYYY-MM-DD) |
Inherited from Message:
| Class Method | get |
Return the protobuf descriptor for this message class. |
| Class Method | is |
Return True if the field contains credentials. |
| Class Method | is |
Return True if the field is marked as sensitive. |
| Method | __repr__ |
Return a human-readable representation of the message, sanitizing sensitive fields. |
| Method | check |
Check explicit presence for a field in the protobuf message. |
| Method | get |
Build a reset mask for a full update of this message. |
| Method | get |
Return the tracked reset mask. |
| Method | is |
Return True if a field equals its default value. |
| Method | set |
Replace the tracked reset mask. |
| Method | which |
Return the set field name for a given oneof. |
| Instance Variable | __PB2 |
Protobuf message class associated with this wrapper. |
| Instance Variable | __pb2 |
Underlying protobuf message instance. |
| Method | _clear |
Clear a field and record it in the reset mask. |
| Method | _get |
Return a field value with optional wrapping and presence handling. |
| Method | _set |
Set a field value and update the reset mask. |
| Class Variable | __credentials |
Undocumented |
| Class Variable | __default |
Undocumented |
| Class Variable | __sensitive |
Undocumented |
| Instance Variable | __recorded |
Mask tracking fields cleared or set to default. |
def __init__(self, initial_message:
message.Message | None = None, *, effective_at: builtins.str | None | unset.UnsetType = unset.Unset, description: builtins.str | None | unset.UnsetType = unset.Unset, description_cli: builtins.str | None | unset.UnsetType = unset.Unset):
(source)
¶
Create a wrapper around a protobuf message instance.
| Raises | |
AttributeError | If the wrapper is missing required class metadata. |
Undocumented
| Value |
|
Undocumented
| Value |
|
A description to help users understand the reason for deprecation and suggest alternatives. By default, this message will be shown in the CLI, Terraform, and SDKs as is.