CreateRelatedDocumentAttachmentDetails

class oci.marketplace_publisher.models.CreateRelatedDocumentAttachmentDetails(**kwargs)

Bases: CreateListingRevisionAttachmentDetails

Create Details of the related document attachment.

Methods:

__init__(**kwargs)

Initializes a new CreateRelatedDocumentAttachmentDetails 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.

Attributes:

attachment_type

[Required] Gets the attachment_type of this CreateListingRevisionAttachmentDetails.

defined_tags

Gets the defined_tags of this CreateListingRevisionAttachmentDetails.

description

Gets the description of this CreateListingRevisionAttachmentDetails.

display_name

Gets the display_name of this CreateListingRevisionAttachmentDetails.

document_category

[Required] Gets the document_category of this CreateRelatedDocumentAttachmentDetails.

freeform_tags

Gets the freeform_tags of this CreateListingRevisionAttachmentDetails.

is_oracle_users_only

Gets the is_oracle_users_only of this CreateRelatedDocumentAttachmentDetails.

listing_revision_id

[Required] Gets the listing_revision_id of this CreateListingRevisionAttachmentDetails.

source_type

Gets the source_type of this CreateRelatedDocumentAttachmentDetails.

source_url

Gets the source_url of this CreateRelatedDocumentAttachmentDetails.

__init__(**kwargs)

Initializes a new CreateRelatedDocumentAttachmentDetails 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
  • listing_revision_id (str) – The value to assign to the listing_revision_id property of this CreateRelatedDocumentAttachmentDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateRelatedDocumentAttachmentDetails.

  • description (str) – The value to assign to the description property of this CreateRelatedDocumentAttachmentDetails.

  • attachment_type (str) – The value to assign to the attachment_type property of this CreateRelatedDocumentAttachmentDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateRelatedDocumentAttachmentDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateRelatedDocumentAttachmentDetails.

  • document_category (str) – The value to assign to the document_category property of this CreateRelatedDocumentAttachmentDetails.

  • source_url (str) – The value to assign to the source_url property of this CreateRelatedDocumentAttachmentDetails.

  • source_type (str) – The value to assign to the source_type property of this CreateRelatedDocumentAttachmentDetails.

  • is_oracle_users_only (bool) – The value to assign to the is_oracle_users_only property of this CreateRelatedDocumentAttachmentDetails.

property attachment_type

[Required] Gets the attachment_type of this CreateListingRevisionAttachmentDetails. The specified attachment type.

Returns

The attachment_type of this CreateListingRevisionAttachmentDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateListingRevisionAttachmentDetails. 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 CreateListingRevisionAttachmentDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateListingRevisionAttachmentDetails. Description for this specified attachment.

Returns

The description of this CreateListingRevisionAttachmentDetails.

Return type

str

property display_name

Gets the display_name of this CreateListingRevisionAttachmentDetails. The name for the listing revision attachment.

Returns

The display_name of this CreateListingRevisionAttachmentDetails.

Return type

str

property document_category

[Required] Gets the document_category of this CreateRelatedDocumentAttachmentDetails. The document category of the listing revision attachment.

Returns

The document_category of this CreateRelatedDocumentAttachmentDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateListingRevisionAttachmentDetails. 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 CreateListingRevisionAttachmentDetails.

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.

property is_oracle_users_only

Gets the is_oracle_users_only of this CreateRelatedDocumentAttachmentDetails. Identifies whether the attachment is for Internal Oracle Users or external users as well.

Returns

The is_oracle_users_only of this CreateRelatedDocumentAttachmentDetails.

Return type

bool

property listing_revision_id

[Required] Gets the listing_revision_id of this CreateListingRevisionAttachmentDetails. The OCID for the listing revision in Marketplace Publisher.

Returns

The listing_revision_id of this CreateListingRevisionAttachmentDetails.

Return type

str

property source_type

Gets the source_type of this CreateRelatedDocumentAttachmentDetails. The specified attachment type is Internal or External.

Returns

The source_type of this CreateRelatedDocumentAttachmentDetails.

Return type

str

property source_url

Gets the source_url of this CreateRelatedDocumentAttachmentDetails. The document URL of the listing revision attachment.

Returns

The source_url of this CreateRelatedDocumentAttachmentDetails.

Return type

str