marketplaceprivateoffer.oracle.com/v1beta1
Back to API Reference
APIVersion: marketplaceprivateoffer.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
No customer-visible package currently exposes marketplaceprivateoffer.oracle.com/v1beta1.
Resources
Attachment
Attachment is the Schema for the attachments API.
Plural: attachmentsScope: NamespacedAPIVersion: marketplaceprivateoffer.oracle.com/v1beta1Sample: Sample (config/samples/marketplaceprivateoffer_v1beta1_attachment.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
AttachmentSpec defines the desired state of Attachment.
| Field |
Description |
Type |
Required |
Default |
Enum |
displayName |
The name used to refer to the uploaded data. |
string |
Yes |
- |
- |
fileBase64Encoded |
Base64-encoded file to attach to the Offer. File must be a PDF with maximum size of 1 MB |
string |
Yes |
- |
- |
type |
The type of offer attachment. |
string |
Yes |
- |
- |
Status
AttachmentStatus defines the observed state of Attachment.
| Field |
Description |
Type |
Required |
Default |
Enum |
buyerCompartmentId |
OCID of the buyer's tenancy (root compartment). |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
The name used to refer to the uploaded data. |
string |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
id |
Unique identifier that is immutable on creation |
string |
No |
- |
- |
lifecycleState |
The current state of the Offer. |
string |
No |
- |
- |
mimeType |
The MIME type of the uploaded data. |
string |
No |
- |
- |
offerId |
Unique identifier of the associated offer that is immutable on creation |
string |
No |
- |
- |
sellerCompartmentId |
OCID of the seller's tenancy (root compartment). |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
timeCreated |
The time the the Offer was created. An RFC3339 formatted datetime string |
string |
No |
- |
- |
type |
The type of offer attachment. |
string |
No |
- |
- |
Status.status
Back to Attachment status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to Attachment status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to Attachment status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to Attachment status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
Offer
Offer is the Schema for the offers API.
Plural: offersScope: NamespacedAPIVersion: marketplaceprivateoffer.oracle.com/v1beta1Sample: Sample (config/samples/marketplaceprivateoffer_v1beta1_offer.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
OfferSpec defines the desired state of Offer.
| Field |
Description |
Type |
Required |
Default |
Enum |
buyerCompartmentId |
Compartment Identifier of the buyer |
string |
No |
- |
- |
buyerInformation |
OfferBuyerInformation defines nested fields for Offer.BuyerInformation. |
object |
No |
- |
- |
customFields |
A list of key value pairs specified by the seller |
list[object] |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
Description of the Offer |
string |
No |
- |
- |
displayName |
Offers Identifier |
string |
Yes |
- |
- |
duration |
Duration the Offer will be active after its start date. An ISO8601 extended formatted string. |
string |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
internalNotes |
Internal notes of the Offer |
string |
No |
- |
- |
pricing |
OfferPricing defines nested fields for Offer.Pricing. |
object |
No |
- |
- |
resourceBundles |
A list of Resource Bundles associated with an Offer. |
list[object] |
No |
- |
- |
sellerCompartmentId |
Compartment Identifier of the seller |
string |
Yes |
- |
- |
sellerInformation |
OfferSellerInformation defines nested fields for Offer.SellerInformation. |
object |
No |
- |
- |
timeAcceptBy |
The time the Offer must be accepted by the Buyer before the Offer becomes invalid. An RFC3339 formatted datetime string |
string |
No |
- |
- |
timeStartDate |
The time the Offer will become active after it has been accepted by the Buyer. An RFC3339 formatted datetime string |
string |
No |
- |
- |
Back to Offer spec
OfferBuyerInformation defines nested fields for Offer.BuyerInformation.
| Field |
Description |
Type |
Required |
Default |
Enum |
additionalContacts |
the additional contacts associated with the buyer |
list[object] |
No |
- |
- |
companyName |
the name of the company for the buyer |
string |
No |
- |
- |
noteToBuyer |
a note the seller can specify for the buyer through a notification email |
string |
No |
- |
- |
primaryContact |
OfferBuyerInformationPrimaryContact defines nested fields for Offer.BuyerInformation.PrimaryContact. |
object |
No |
- |
- |
Back to Offer spec
OfferBuyerInformationAdditionalContact defines nested fields for Offer.BuyerInformation.AdditionalContact.
| Field |
Description |
Type |
Required |
Default |
Enum |
email |
The email of the contact |
string |
No |
- |
- |
firstName |
The first name of the contact |
string |
No |
- |
- |
lastName |
The last name of the contact |
string |
No |
- |
- |
Back to Offer spec
OfferBuyerInformationPrimaryContact defines nested fields for Offer.BuyerInformation.PrimaryContact.
| Field |
Description |
Type |
Required |
Default |
Enum |
email |
The email of the contact |
string |
No |
- |
- |
firstName |
The first name of the contact |
string |
No |
- |
- |
lastName |
The last name of the contact |
string |
No |
- |
- |
Spec.customFields[]
Back to Offer spec
OfferCustomField defines nested fields for Offer.CustomField.
| Field |
Description |
Type |
Required |
Default |
Enum |
key |
the key of the custom field |
string |
No |
- |
- |
value |
the value of the custom field |
string |
No |
- |
- |
Spec.pricing
Back to Offer spec
OfferPricing defines nested fields for Offer.Pricing.
| Field |
Description |
Type |
Required |
Default |
Enum |
billingCycle |
The frequency at which the customer is billed for the Offer |
string |
No |
- |
- |
currencyType |
The currency supported for a given Offer, in the format specified by ISO-4217 |
string |
No |
- |
- |
totalAmount |
The total amount an Offer costs |
integer (int64) |
No |
- |
- |
Spec.resourceBundles[]
Back to Offer spec
OfferResourceBundle defines nested fields for Offer.ResourceBundle.
| Field |
Description |
Type |
Required |
Default |
Enum |
quantity |
The quantity of a resources associated with the bundle |
integer (int64) |
No |
- |
- |
resourceIds |
the ids of the resources in the Offer |
list[string] |
No |
- |
- |
type |
The type of resources in the bundle |
string |
No |
- |
- |
unitOfMeasurement |
The unit of measurement for the resource bundle |
string |
No |
- |
- |
Back to Offer spec
OfferSellerInformation defines nested fields for Offer.SellerInformation.
| Field |
Description |
Type |
Required |
Default |
Enum |
additionalContacts |
the additional contacts associated with the seller |
list[object] |
No |
- |
- |
primaryContact |
OfferSellerInformationPrimaryContact defines nested fields for Offer.SellerInformation.PrimaryContact. |
object |
No |
- |
- |
Back to Offer spec
OfferSellerInformationAdditionalContact defines nested fields for Offer.SellerInformation.AdditionalContact.
| Field |
Description |
Type |
Required |
Default |
Enum |
email |
The email of the contact |
string |
No |
- |
- |
firstName |
The first name of the contact |
string |
No |
- |
- |
lastName |
The last name of the contact |
string |
No |
- |
- |
Back to Offer spec
OfferSellerInformationPrimaryContact defines nested fields for Offer.SellerInformation.PrimaryContact.
| Field |
Description |
Type |
Required |
Default |
Enum |
email |
The email of the contact |
string |
No |
- |
- |
firstName |
The first name of the contact |
string |
No |
- |
- |
lastName |
The last name of the contact |
string |
No |
- |
- |
Status
OfferStatus defines the observed state of Offer.
| Field |
Description |
Type |
Required |
Default |
Enum |
buyerCompartmentId |
OCID of the buyer's tenancy (root compartment). |
string |
No |
- |
- |
buyerInformation |
OfferBuyerInformation defines nested fields for Offer.BuyerInformation. |
object |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
The description of the offer |
string |
No |
- |
- |
displayName |
Offer Identifier, can be renamed |
string |
No |
- |
- |
duration |
Duration the Offer will be active after its start date. An ISO8601 extended formatted string. |
string |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
id |
Unique identifier that is immutable on creation |
string |
No |
- |
- |
lifecycleDetails |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. |
string |
No |
- |
- |
lifecycleState |
The current state of the Offer. |
string |
No |
- |
- |
offerStatus |
A substate for lifeCycleStatus to give a more human readable version of the offer |
string |
No |
- |
- |
pricing |
OfferPricing defines nested fields for Offer.Pricing. |
object |
No |
- |
- |
publisherSummary |
OfferPublisherSummary defines nested fields for Offer.PublisherSummary. |
object |
No |
- |
- |
resourceBundles |
A list of Resource Bundles associated with an Offer. |
list[object] |
No |
- |
- |
sellerCompartmentId |
OCID of the seller's tenancy (root compartment). |
string |
No |
- |
- |
sellerInformation |
OfferSellerInformation defines nested fields for Offer.SellerInformation. |
object |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
timeAcceptBy |
The time the Offer must be accepted by the Buyer before the Offer becomes invalid. An RFC3339 formatted datetime string |
string |
No |
- |
- |
timeAccepted |
The time the Offer was accepted by the Buyer of the Offer. An RFC3339 formatted datetime string |
string |
No |
- |
- |
timeCreated |
The time the the Offer was created. An RFC3339 formatted datetime string |
string |
No |
- |
- |
timeOfferEnd |
The time the accepted Offer will end. An RFC3339 formatted datetime string |
string |
No |
- |
- |
timeStartDate |
The time the Offer will become active after it has been accepted by the Buyer. An RFC3339 formatted datetime string |
string |
No |
- |
- |
timeUpdated |
The time the Offer was updated. An RFC3339 formatted datetime string |
string |
No |
- |
- |
Back to Offer status
OfferBuyerInformation defines nested fields for Offer.BuyerInformation.
| Field |
Description |
Type |
Required |
Default |
Enum |
additionalContacts |
the additional contacts associated with the buyer |
list[object] |
No |
- |
- |
companyName |
the name of the company for the buyer |
string |
No |
- |
- |
noteToBuyer |
a note the seller can specify for the buyer through a notification email |
string |
No |
- |
- |
primaryContact |
OfferBuyerInformationPrimaryContact defines nested fields for Offer.BuyerInformation.PrimaryContact. |
object |
No |
- |
- |
Back to Offer status
OfferBuyerInformationAdditionalContact defines nested fields for Offer.BuyerInformation.AdditionalContact.
| Field |
Description |
Type |
Required |
Default |
Enum |
email |
The email of the contact |
string |
No |
- |
- |
firstName |
The first name of the contact |
string |
No |
- |
- |
lastName |
The last name of the contact |
string |
No |
- |
- |
Back to Offer status
OfferBuyerInformationPrimaryContact defines nested fields for Offer.BuyerInformation.PrimaryContact.
| Field |
Description |
Type |
Required |
Default |
Enum |
email |
The email of the contact |
string |
No |
- |
- |
firstName |
The first name of the contact |
string |
No |
- |
- |
lastName |
The last name of the contact |
string |
No |
- |
- |
Status.pricing
Back to Offer status
OfferPricing defines nested fields for Offer.Pricing.
| Field |
Description |
Type |
Required |
Default |
Enum |
billingCycle |
The frequency at which the customer is billed for the Offer |
string |
No |
- |
- |
currencyType |
The currency supported for a given Offer, in the format specified by ISO-4217 |
string |
No |
- |
- |
totalAmount |
The total amount an Offer costs |
integer (int64) |
No |
- |
- |
Status.publisherSummary
Back to Offer status
OfferPublisherSummary defines nested fields for Offer.PublisherSummary.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The root compartment of the Publisher. |
string |
No |
- |
- |
contactEmail |
The public email address of the publisher for customers. |
string |
No |
- |
- |
contactPhone |
The phone number of the publisher in E.164 format. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
description |
A description of the publisher. |
string |
No |
- |
- |
displayName |
The name of the publisher. |
string |
No |
- |
- |
facebookUrl |
Publisher's Facebook URL |
string |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
hqAddress |
The address of the publisher's headquarters. |
string |
No |
- |
- |
id |
Unique OCID identifier for the publisher. |
string |
No |
- |
- |
legacyId |
Unique legacy service identifier for the publisher. |
string |
No |
- |
- |
linkedinUrl |
Publisher's LinkedIn URL |
string |
No |
- |
- |
logo |
OfferPublisherSummaryLogo defines nested fields for Offer.PublisherSummary.Logo. |
object |
No |
- |
- |
publisherType |
publisher type. |
string |
No |
- |
- |
registryNamespace |
The namespace for the publisher registry to persist artifacts. |
string |
No |
- |
- |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
- |
- |
timeCreated |
The time the publisher was created. An RFC3339 formatted datetime string. |
string |
No |
- |
- |
timeUpdated |
The time the publisher was updated. An RFC3339 formatted datetime string. |
string |
No |
- |
- |
twitterUrl |
Publisher's Twitter URL |
string |
No |
- |
- |
websiteUrl |
The publisher's website. |
string |
No |
- |
- |
yearFounded |
The year the publisher's company or organization was founded. |
integer (int64) |
No |
- |
- |
Status.publisherSummary.logo
Back to Offer status
OfferPublisherSummaryLogo defines nested fields for Offer.PublisherSummary.Logo.
| Field |
Description |
Type |
Required |
Default |
Enum |
contentUrl |
The content URL of the upload data. |
string |
No |
- |
- |
mimeType |
The MIME type of the upload data. |
string |
No |
- |
- |
name |
The name used to refer to the upload data. |
string |
No |
- |
- |
Status.resourceBundles[]
Back to Offer status
OfferResourceBundle defines nested fields for Offer.ResourceBundle.
| Field |
Description |
Type |
Required |
Default |
Enum |
quantity |
The quantity of a resources associated with the bundle |
integer (int64) |
No |
- |
- |
resourceIds |
the ids of the resources in the Offer |
list[string] |
No |
- |
- |
type |
The type of resources in the bundle |
string |
No |
- |
- |
unitOfMeasurement |
The unit of measurement for the resource bundle |
string |
No |
- |
- |
Back to Offer status
OfferSellerInformation defines nested fields for Offer.SellerInformation.
| Field |
Description |
Type |
Required |
Default |
Enum |
additionalContacts |
the additional contacts associated with the seller |
list[object] |
No |
- |
- |
primaryContact |
OfferSellerInformationPrimaryContact defines nested fields for Offer.SellerInformation.PrimaryContact. |
object |
No |
- |
- |
Back to Offer status
OfferSellerInformationAdditionalContact defines nested fields for Offer.SellerInformation.AdditionalContact.
| Field |
Description |
Type |
Required |
Default |
Enum |
email |
The email of the contact |
string |
No |
- |
- |
firstName |
The first name of the contact |
string |
No |
- |
- |
lastName |
The last name of the contact |
string |
No |
- |
- |
Back to Offer status
OfferSellerInformationPrimaryContact defines nested fields for Offer.SellerInformation.PrimaryContact.
| Field |
Description |
Type |
Required |
Default |
Enum |
email |
The email of the contact |
string |
No |
- |
- |
firstName |
The first name of the contact |
string |
No |
- |
- |
lastName |
The last name of the contact |
string |
No |
- |
- |
Status.status
Back to Offer status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to Offer status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to Offer status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to Offer status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |