RelatedDocumentAttachment¶

class oci.marketplace_publisher.models.RelatedDocumentAttachment(**kwargs)¶

Bases: oci.marketplace_publisher.models.listing_revision_attachment.ListingRevisionAttachment

Related document attachment for the listing revision.

Attributes

`ATTACHMENT_TYPE_RELATED_DOCUMENT`	str(object=’’) -> str
`ATTACHMENT_TYPE_SCREENSHOT`	str(object=’’) -> str
`ATTACHMENT_TYPE_VIDEO`	str(object=’’) -> str
`DOCUMENT_CATEGORY_CASE_STUDIES`	A constant which can be used with the document_category property of a RelatedDocumentAttachment.
`DOCUMENT_CATEGORY_CUSTOMIZATION_GUIDES`	A constant which can be used with the document_category property of a RelatedDocumentAttachment.
`DOCUMENT_CATEGORY_DATA_SHEETS`	A constant which can be used with the document_category property of a RelatedDocumentAttachment.
`DOCUMENT_CATEGORY_PRESS_RELEASE`	A constant which can be used with the document_category property of a RelatedDocumentAttachment.
`DOCUMENT_CATEGORY_PRODUCT_DOCUMENTATION`	A constant which can be used with the document_category property of a RelatedDocumentAttachment.
`DOCUMENT_CATEGORY_USER_GUIDES`	A constant which can be used with the document_category property of a RelatedDocumentAttachment.
`DOCUMENT_CATEGORY_WEBINAR`	A constant which can be used with the document_category property of a RelatedDocumentAttachment.
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_INACTIVE`	str(object=’’) -> str
`attachment_type`	[Required] Gets the attachment_type of this ListingRevisionAttachment.
`compartment_id`	[Required] Gets the compartment_id of this ListingRevisionAttachment.
`content_url`	Gets the content_url of this RelatedDocumentAttachment.
`defined_tags`	Gets the defined_tags of this ListingRevisionAttachment.
`description`	Gets the description of this ListingRevisionAttachment.
`display_name`	[Required] Gets the display_name of this ListingRevisionAttachment.
`document_category`	Gets the document_category of this RelatedDocumentAttachment.
`freeform_tags`	Gets the freeform_tags of this ListingRevisionAttachment.
`id`	[Required] Gets the id of this ListingRevisionAttachment.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ListingRevisionAttachment.
`listing_revision_id`	[Required] Gets the listing_revision_id of this ListingRevisionAttachment.
`mime_type`	Gets the mime_type of this RelatedDocumentAttachment.
`system_tags`	Gets the system_tags of this ListingRevisionAttachment.
`time_created`	[Required] Gets the time_created of this ListingRevisionAttachment.
`time_updated`	[Required] Gets the time_updated of this ListingRevisionAttachment.

Methods

`__init__`(**kwargs)	Initializes a new RelatedDocumentAttachment object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ATTACHMENT_TYPE_RELATED_DOCUMENT = 'RELATED_DOCUMENT'¶

ATTACHMENT_TYPE_SCREENSHOT = 'SCREENSHOT'¶

ATTACHMENT_TYPE_VIDEO = 'VIDEO'¶

DOCUMENT_CATEGORY_CASE_STUDIES = 'CASE_STUDIES'¶: A constant which can be used with the document_category property of a RelatedDocumentAttachment. This constant has a value of “CASE_STUDIES”

DOCUMENT_CATEGORY_CUSTOMIZATION_GUIDES = 'CUSTOMIZATION_GUIDES'¶: A constant which can be used with the document_category property of a RelatedDocumentAttachment. This constant has a value of “CUSTOMIZATION_GUIDES”

DOCUMENT_CATEGORY_DATA_SHEETS = 'DATA_SHEETS'¶: A constant which can be used with the document_category property of a RelatedDocumentAttachment. This constant has a value of “DATA_SHEETS”

DOCUMENT_CATEGORY_PRESS_RELEASE = 'PRESS_RELEASE'¶: A constant which can be used with the document_category property of a RelatedDocumentAttachment. This constant has a value of “PRESS_RELEASE”

DOCUMENT_CATEGORY_PRODUCT_DOCUMENTATION = 'PRODUCT_DOCUMENTATION'¶: A constant which can be used with the document_category property of a RelatedDocumentAttachment. This constant has a value of “PRODUCT_DOCUMENTATION”

DOCUMENT_CATEGORY_USER_GUIDES = 'USER_GUIDES'¶: A constant which can be used with the document_category property of a RelatedDocumentAttachment. This constant has a value of “USER_GUIDES”

DOCUMENT_CATEGORY_WEBINAR = 'WEBINAR'¶: A constant which can be used with the document_category property of a RelatedDocumentAttachment. This constant has a value of “WEBINAR”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶

__init__(**kwargs)¶

Initializes a new RelatedDocumentAttachment object with values from keyword arguments. The default value of the attachment_type attribute of this class is RELATED_DOCUMENT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this RelatedDocumentAttachment.
compartment_id (str) – The value to assign to the compartment_id property of this RelatedDocumentAttachment.
listing_revision_id (str) – The value to assign to the listing_revision_id property of this RelatedDocumentAttachment.
display_name (str) – The value to assign to the display_name property of this RelatedDocumentAttachment.
description (str) – The value to assign to the description property of this RelatedDocumentAttachment.
attachment_type (str) – The value to assign to the attachment_type property of this RelatedDocumentAttachment. Allowed values for this property are: “RELATED_DOCUMENT”, “SCREENSHOT”, “VIDEO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this RelatedDocumentAttachment. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this RelatedDocumentAttachment.
time_updated (datetime) – The value to assign to the time_updated property of this RelatedDocumentAttachment.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RelatedDocumentAttachment.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RelatedDocumentAttachment.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RelatedDocumentAttachment.
document_category (str) – The value to assign to the document_category property of this RelatedDocumentAttachment. Allowed values for this property are: “CASE_STUDIES”, “CUSTOMIZATION_GUIDES”, “DATA_SHEETS”, “PRESS_RELEASE”, “PRODUCT_DOCUMENTATION”, “USER_GUIDES”, “WEBINAR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
content_url (str) – The value to assign to the content_url property of this RelatedDocumentAttachment.
mime_type (str) – The value to assign to the mime_type property of this RelatedDocumentAttachment.

attachment_type¶

[Required] Gets the attachment_type of this ListingRevisionAttachment. Possible values for the publisher listing revision attachments. The attachment type informs the type of attachment for the listing revision.

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

Returns:	The attachment_type of this ListingRevisionAttachment.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ListingRevisionAttachment. The unique identifier for the compartment.

Returns:	The compartment_id of this ListingRevisionAttachment.
Return type:	str

content_url¶

Gets the content_url of this RelatedDocumentAttachment. URL of the uploaded document.

Returns:	The content_url of this RelatedDocumentAttachment.
Return type:	str

defined_tags¶

Gets the defined_tags of this ListingRevisionAttachment. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this ListingRevisionAttachment.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this ListingRevisionAttachment. Description of the listing revision attachment.

Returns:	The description of this ListingRevisionAttachment.
Return type:	str

display_name¶

[Required] Gets the display_name of this ListingRevisionAttachment. Name of the listing revision attachment.

Returns:	The display_name of this ListingRevisionAttachment.
Return type:	str

document_category¶

Gets the document_category of this RelatedDocumentAttachment. Possible lifecycle states.

Allowed values for this property are: “CASE_STUDIES”, “CUSTOMIZATION_GUIDES”, “DATA_SHEETS”, “PRESS_RELEASE”, “PRODUCT_DOCUMENTATION”, “USER_GUIDES”, “WEBINAR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The document_category of this RelatedDocumentAttachment.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ListingRevisionAttachment. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this ListingRevisionAttachment.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id¶

[Required] Gets the id of this ListingRevisionAttachment. Unique OCID identifier for the listing revision attachment.

Returns:	The id of this ListingRevisionAttachment.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ListingRevisionAttachment. The current state of the attachment.

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

Returns:	The lifecycle_state of this ListingRevisionAttachment.
Return type:	str

listing_revision_id¶

[Required] Gets the listing_revision_id of this ListingRevisionAttachment. The unique identifier of the listing revision that the specified attachment belongs to.

Returns:	The listing_revision_id of this ListingRevisionAttachment.
Return type:	str

mime_type¶

Gets the mime_type of this RelatedDocumentAttachment. The MIME type of the uploaded data.

Returns:	The mime_type of this RelatedDocumentAttachment.
Return type:	str

system_tags¶

Gets the system_tags of this ListingRevisionAttachment. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ListingRevisionAttachment.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this ListingRevisionAttachment. The time the attachment was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this ListingRevisionAttachment.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this ListingRevisionAttachment. The time the attachment was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this ListingRevisionAttachment.
Return type:	datetime