ContainerRepositoryReadme

class oci.artifacts.models.ContainerRepositoryReadme(**kwargs)

Bases: object

Container repository readme.

Attributes:

FORMAT_TEXT_MARKDOWN	A constant which can be used with the format property of a ContainerRepositoryReadme.
FORMAT_TEXT_PLAIN	A constant which can be used with the format property of a ContainerRepositoryReadme.
content	[Required] Gets the content of this ContainerRepositoryReadme.
format	[Required] Gets the format of this ContainerRepositoryReadme.

Methods:

__init__(**kwargs)

Initializes a new ContainerRepositoryReadme object with values from keyword arguments.

FORMAT_TEXT_MARKDOWN = 'TEXT_MARKDOWN'

A constant which can be used with the format property of a ContainerRepositoryReadme. This constant has a value of “TEXT_MARKDOWN”

FORMAT_TEXT_PLAIN = 'TEXT_PLAIN'

A constant which can be used with the format property of a ContainerRepositoryReadme. This constant has a value of “TEXT_PLAIN”

__init__(**kwargs)

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

Parameters

• content (str) – The value to assign to the content property of this ContainerRepositoryReadme.

• format (str) – The value to assign to the format property of this ContainerRepositoryReadme. Allowed values for this property are: “TEXT_MARKDOWN”, “TEXT_PLAIN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property content

[Required] Gets the content of this ContainerRepositoryReadme. Readme content. Avoid entering confidential information.

Returns

The content of this ContainerRepositoryReadme.

Return type

str

property format

[Required] Gets the format of this ContainerRepositoryReadme. Readme format. Supported formats are text/plain and text/markdown.

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

Returns

The format of this ContainerRepositoryReadme.

Return type

str