v1/common.proto#

Messages#

BestEffortCleanupWarning#

BestEffortCleanupWarning records a cleanup error that was intentionally ignored so the primary operation could continue.

Field

Type

Description

kind

string

Cleanup warning category, for example “redfish_policy_cleanup”.

operation

string

Best-effort operation that produced the warning.

affected_object_type

string

Type of object affected by the cleanup warning.

affected_object_name

string

Name of the object affected by the cleanup warning.

affected_domain

string

Redfish/domain identifier affected by the cleanup warning.

affected_endpoint

string

Endpoint affected by the cleanup warning.

ignored_error

string

Error that was ignored to preserve the primary operation.

Status#

Status denotes operation status

Field

Type

Description

ok

bool

Whether or not the operation was successful

diag_msg

string

Diagnostic msg, if any

ValidationError#

ValidationError contains a single topology validation error

Field

Type

Description

object_name

string

The name of the object with the validation failure

object_type

string

The type of object with the validation failure

error

string

The type of error

message

string

The error message

Scalar Value Types#

.proto Type

Notes

C++ Type

Java Type

Python Type

double

double

double

float

float

float

float

float

int32

Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.

int32

int

int

int64

Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.

int64

long

int/long

uint32

Uses variable-length encoding.

uint32

int

int/long

uint64

Uses variable-length encoding.

uint64

long

int/long

sint32

Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.

int32

int

int

sint64

Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.

int64

long

int/long

fixed32

Always four bytes. More efficient than uint32 if values are often greater than 2^28.

uint32

int

int

fixed64

Always eight bytes. More efficient than uint64 if values are often greater than 2^56.

uint64

long

int/long

sfixed32

Always four bytes.

int32

int

int

sfixed64

Always eight bytes.

int64

long

int/long

bool

bool

boolean

boolean

string

A string must always contain UTF-8 encoded or 7-bit ASCII text.

string

String

str/unicode

bytes

May contain any arbitrary sequence of bytes.

string

ByteString

str