SystemDeviceManagementTagAddRequest22

Bases: OCIRequest

Request to add a static configuration tag.

The following elements are only used in XS data mode and ignored in AS data mode:
  isTagValueEncrypted
  tagValueToEncrypt

The response is either a SuccessResponse or an ErrorResponse.

Attributes:

system_default_tag_set (Optional[bool]):

tag_set_name (Optional[str]):

tag_name (str):

is_tag_value_encrypted (Optional[bool]):

tag_value (Optional[str]):

tag_value_to_encrypt (Optional[str]):

is_tag_value_overridable (bool):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class SystemDeviceManagementTagAddRequest22(OCIRequest):
    """Request to add a static configuration tag.

        The following elements are only used in XS data mode and ignored in AS data mode:
          isTagValueEncrypted
          tagValueToEncrypt

        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        system_default_tag_set (Optional[bool]):

        tag_set_name (Optional[str]):

        tag_name (str):

        is_tag_value_encrypted (Optional[bool]):

        tag_value (Optional[str]):

        tag_value_to_encrypt (Optional[str]):

        is_tag_value_overridable (bool):

    """

    system_default_tag_set: Optional[bool] = field(
        default=None, metadata={"alias": "systemDefaultTagSet"}
    )

    tag_set_name: Optional[str] = field(default=None, metadata={"alias": "tagSetName"})

    tag_name: str = field(metadata={"alias": "tagName"})

    is_tag_value_encrypted: Optional[bool] = field(
        default=None, metadata={"alias": "isTagValueEncrypted"}
    )

    tag_value: Optional[str] = field(default=None, metadata={"alias": "tagValue"})

    tag_value_to_encrypt: Optional[str] = field(
        default=None, metadata={"alias": "tagValueToEncrypt"}
    )

    is_tag_value_overridable: bool = field(metadata={"alias": "isTagValueOverridable"})

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import SystemDeviceManagementTagAddRequest22

client = Client()

command = SystemDeviceManagementTagAddRequest22(
    system_default_tag_set=...,
    tag_set_name=...,
    tag_name=...,
    is_tag_value_encrypted=...,
    tag_value=...,
    tag_value_to_encrypt=...,
    is_tag_value_overridable=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemDeviceManagementTagAddRequest22",
    system_default_tag_set=...,
    tag_set_name=...,
    tag_name=...,
    is_tag_value_encrypted=...,
    tag_value=...,
    tag_value_to_encrypt=...,
    is_tag_value_overridable=...,
)

print(response)