func GetBundleSkuQuantityRuleEnumStringValues() []string
GetBundleSkuQuantityRuleEnumStringValues Enumerates the set of values in String for BundleSkuQuantityRuleEnum
func GetCcdCommitmentLifecycleDetailsEnumStringValues() []string
GetCcdCommitmentLifecycleDetailsEnumStringValues Enumerates the set of values in String for CcdCommitmentLifecycleDetailsEnum
func GetCcdCommitmentLifecycleStateEnumStringValues() []string
GetCcdCommitmentLifecycleStateEnumStringValues Enumerates the set of values in String for CcdCommitmentLifecycleStateEnum
func GetCcdOfferCustomerSegmentEnumStringValues() []string
GetCcdOfferCustomerSegmentEnumStringValues Enumerates the set of values in String for CcdOfferCustomerSegmentEnum
func GetCcdOfferLifecycleDetailsEnumStringValues() []string
GetCcdOfferLifecycleDetailsEnumStringValues Enumerates the set of values in String for CcdOfferLifecycleDetailsEnum
func GetCcdOfferLifecycleStateEnumStringValues() []string
GetCcdOfferLifecycleStateEnumStringValues Enumerates the set of values in String for CcdOfferLifecycleStateEnum
func GetCcdOfferReclaimTermUnitEnumStringValues() []string
GetCcdOfferReclaimTermUnitEnumStringValues Enumerates the set of values in String for CcdOfferReclaimTermUnitEnum
func GetCcdOfferSourceTypeEnumStringValues() []string
GetCcdOfferSourceTypeEnumStringValues Enumerates the set of values in String for CcdOfferSourceTypeEnum
func GetCcdOfferSummaryCustomerSegmentEnumStringValues() []string
GetCcdOfferSummaryCustomerSegmentEnumStringValues Enumerates the set of values in String for CcdOfferSummaryCustomerSegmentEnum
func GetCcdOfferSummaryTypeOfOfferEnumStringValues() []string
GetCcdOfferSummaryTypeOfOfferEnumStringValues Enumerates the set of values in String for CcdOfferSummaryTypeOfOfferEnum
func GetCcdOfferSummaryUnitEnumStringValues() []string
GetCcdOfferSummaryUnitEnumStringValues Enumerates the set of values in String for CcdOfferSummaryUnitEnum
func GetCcdOfferTypeOfOfferEnumStringValues() []string
GetCcdOfferTypeOfOfferEnumStringValues Enumerates the set of values in String for CcdOfferTypeOfOfferEnum
func GetCcdOfferUnitEnumStringValues() []string
GetCcdOfferUnitEnumStringValues Enumerates the set of values in String for CcdOfferUnitEnum
func GetListCcdCommitmentsSortByEnumStringValues() []string
GetListCcdCommitmentsSortByEnumStringValues Enumerates the set of values in String for ListCcdCommitmentsSortByEnum
func GetListCcdCommitmentsSortOrderEnumStringValues() []string
GetListCcdCommitmentsSortOrderEnumStringValues Enumerates the set of values in String for ListCcdCommitmentsSortOrderEnum
func GetListCcdOffersSortByEnumStringValues() []string
GetListCcdOffersSortByEnumStringValues Enumerates the set of values in String for ListCcdOffersSortByEnum
func GetListCcdOffersSortOrderEnumStringValues() []string
GetListCcdOffersSortOrderEnumStringValues Enumerates the set of values in String for ListCcdOffersSortOrderEnum
func GetPricesModelEnumStringValues() []string
GetPricesModelEnumStringValues Enumerates the set of values in String for PricesModelEnum
BundleSku A polymorphic bundle SKU. The `quantityRule` discriminator identifies how the quantity for this bundled SKU is determined. Every bundled SKU in an offer must use the same `quantityRule`; don't mix `FIXED_RATIO` and `CUSTOMER_SELECTED` bundled SKUs in one offer.
type BundleSku interface {
// The bundled SKU part number (prefaced with "B"). For example, the "E4 MEMORY" SKU will be bundled with the main "E4 OCPUs" SKU.
GetSku() *string
// The SKU display name is derived by CCD. If CCD cannot derive a unique value, it uses the caller-provided value.
GetSkuDisplayName() *string
// The SKU billing metric is derived by CCD. If CCD cannot derive a unique value, it uses the caller-provided value.
GetSkuMetric() *string
// List price of a SKU. Only set this property if the product or SKU is private. Tier pricing SKUs aren't supported.
GetListPrice() *string
// The currency code of `listPrice` associated with the product or SKU. Only set this property if the product or SKU is private.
// Tier pricing SKUs aren't supported.
GetCurrencyCode() *string
}
BundleSkuQuantityRuleEnum Enum with underlying type: string
type BundleSkuQuantityRuleEnum string
Set of constants representing the allowable values for BundleSkuQuantityRuleEnum
const (
BundleSkuQuantityRuleFixedRatio BundleSkuQuantityRuleEnum = "FIXED_RATIO"
BundleSkuQuantityRuleCustomerSelected BundleSkuQuantityRuleEnum = "CUSTOMER_SELECTED"
)
func GetBundleSkuQuantityRuleEnumValues() []BundleSkuQuantityRuleEnum
GetBundleSkuQuantityRuleEnumValues Enumerates the set of values for BundleSkuQuantityRuleEnum
func GetMappingBundleSkuQuantityRuleEnum(val string) (BundleSkuQuantityRuleEnum, bool)
GetMappingBundleSkuQuantityRuleEnum performs case Insensitive comparison on enum value and return the desired enum
CcdCommitment The created CCD commitment details.
type CcdCommitment struct {
// The CCD commitment resource OCID.
Id *string `mandatory:"true" json:"id"`
// The hourly quantity that the customer is committing to a CCD offer's main SKU.
// For example, if the quantity is 1000, then you are committing to a 1000 usage quantity value per hour.
Quantity *int64 `mandatory:"true" json:"quantity"`
// The CCD commitment name. Ensure the name is unique for a given subscription ID. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The CCD offer OCID.
OfferId *string `mandatory:"true" json:"offerId"`
// The commercial workflow of the associated CCD offer.
SourceType CcdOfferSourceTypeEnum `mandatory:"true" json:"sourceType"`
// The date and time the CCD commitment will be effective.The format is defined by RFC 3339.
TimeCcdCommitmentStarts *common.SDKTime `mandatory:"true" json:"timeCcdCommitmentStarts"`
// The date and time the CCD commitment will be deactivated. The date and time is calculated based on `timeCcdCommitmentStarts`, the term, and units
// of the CCD offer. For example: `2025-06-01T03:00:00`. The format is defined by RFC 3339.
TimeCcdCommitmentEnds *common.SDKTime `mandatory:"true" json:"timeCcdCommitmentEnds"`
// The subscription ID the CCD offer is applicable to.
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
// The root compartment ID. The CCD Commitment is associated with the tenancy root compartment ID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The reclaim term copied from the offer when the commitment is created. The value is measured in
// `reclaimTermUnit`.
ReclaimTerm *int64 `mandatory:"false" json:"reclaimTerm"`
// The unit used to measure `reclaimTerm`, copied from the offer when the commitment is created.
ReclaimTermUnit CcdOfferReclaimTermUnitEnum `mandatory:"false" json:"reclaimTermUnit,omitempty"`
// The tenancy OCID that you want to apply filler usage to.
FillerTenancyId *string `mandatory:"false" json:"fillerTenancyId"`
// The filler tenancy home region.
FillerTenancyHomeRegion *string `mandatory:"false" json:"fillerTenancyHomeRegion"`
UsageEligibility *UsageEligibility `mandatory:"false" json:"usageEligibility"`
// Secondary SKUs associated with the main SKU.
SecondarySkus []SecondarySkus `mandatory:"false" json:"secondarySkus"`
// This state always defaults to `Active`. For a detailed and exact state,
// check the `lifecycleDetails` state.
LifecycleState CcdCommitmentLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The CCD commitment's current state. A commitment that's expected to get a dedicated capacity will be in the
// Awaiting Provisioning state unless the commitment is ended or canceled. Otherwise, the value is determined by
// `timeCcdCommitmentStarts`, `timeCcdCommitmentEnds`, and `timeTerminated`, with respect to the current time.
LifecycleDetails CcdCommitmentLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// The list of SKUs associated with the commitment and their prices in all currency codes.
SkuQuantityPriceModel []CommittedSkuQuantityPriceModel `mandatory:"false" json:"skuQuantityPriceModel"`
// Date and time the CCD was created. The format is defined by RFC 3339.
// Example: `2022-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date and time the CCD was updated lastly. The format is defined by RFC 3339.
// Example: `2025-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Date and time the CCD was terminated. The format is defined by RFC 3339.
// Example: `2022-01-25T21:10:29.600Z`
TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Entity/User who lastly updated the ccdCommitment.
LastUpdatedBy *string `mandatory:"false" json:"lastUpdatedBy"`
// The entity that created the CCD commitment.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Entity/User who approved the ccdCommitment.
ApprovedBy *string `mandatory:"false" json:"approvedBy"`
}
func (m CcdCommitment) String() string
func (m CcdCommitment) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CcdCommitmentCollection CCD commitment summary items.
type CcdCommitmentCollection struct {
// The CCD commitment summary.
Items []CcdCommitmentSummary `mandatory:"true" json:"items"`
}
func (m CcdCommitmentCollection) String() string
func (m CcdCommitmentCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CcdCommitmentLifecycleDetailsEnum Enum with underlying type: string
type CcdCommitmentLifecycleDetailsEnum string
Set of constants representing the allowable values for CcdCommitmentLifecycleDetailsEnum
const (
CcdCommitmentLifecycleDetailsCurrent CcdCommitmentLifecycleDetailsEnum = "CURRENT"
CcdCommitmentLifecycleDetailsEnded CcdCommitmentLifecycleDetailsEnum = "ENDED"
CcdCommitmentLifecycleDetailsCanceled CcdCommitmentLifecycleDetailsEnum = "CANCELED"
CcdCommitmentLifecycleDetailsScheduled CcdCommitmentLifecycleDetailsEnum = "SCHEDULED"
CcdCommitmentLifecycleDetailsAwaitingProvisioning CcdCommitmentLifecycleDetailsEnum = "AWAITING_PROVISIONING"
)
func GetCcdCommitmentLifecycleDetailsEnumValues() []CcdCommitmentLifecycleDetailsEnum
GetCcdCommitmentLifecycleDetailsEnumValues Enumerates the set of values for CcdCommitmentLifecycleDetailsEnum
func GetMappingCcdCommitmentLifecycleDetailsEnum(val string) (CcdCommitmentLifecycleDetailsEnum, bool)
GetMappingCcdCommitmentLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
CcdCommitmentLifecycleStateEnum Enum with underlying type: string
type CcdCommitmentLifecycleStateEnum string
Set of constants representing the allowable values for CcdCommitmentLifecycleStateEnum
const (
CcdCommitmentLifecycleStateActive CcdCommitmentLifecycleStateEnum = "ACTIVE"
)
func GetCcdCommitmentLifecycleStateEnumValues() []CcdCommitmentLifecycleStateEnum
GetCcdCommitmentLifecycleStateEnumValues Enumerates the set of values for CcdCommitmentLifecycleStateEnum
func GetMappingCcdCommitmentLifecycleStateEnum(val string) (CcdCommitmentLifecycleStateEnum, bool)
GetMappingCcdCommitmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
CcdCommitmentSummary The CCD commitment summary.
type CcdCommitmentSummary struct {
// The CCD commitment resource OCID.
Id *string `mandatory:"true" json:"id"`
// The hourly quantity that the customer is committing to a CCD offer's main SKU.
// For example, if the quantity is 1000, then you are committing to a 1000 usage quantity value per hour.
Quantity *int64 `mandatory:"true" json:"quantity"`
// The CCD offer OCID.
OfferId *string `mandatory:"true" json:"offerId"`
// The date and time, rounded down to an hour, that the CCD commitment will be effective.
// The format conforms to RFC 3339.
TimeCcdCommitmentStarts *common.SDKTime `mandatory:"true" json:"timeCcdCommitmentStarts"`
// The date and time the CCD commitment ends, which is calculated from the `timeCcdCommitmentStarts` of the `ccdCommitment`,
// the term, and `ccdOffer` units. The format must conform to RFC 3339.
TimeCcdCommitmentEnds *common.SDKTime `mandatory:"true" json:"timeCcdCommitmentEnds"`
// The subscription OCID the CCD commitment is applicable to.
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
// The root compartment ID associated with the CCD offer the customer has signed up for.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The CCD commitment's current state. A commitment that's expected to get a dedicated capacity will be in the
// Awaiting Provisioning state unless the commitment is ended or canceled. Otherwise, the value is determined by
// `timeCcdCommitmentStarts`, `timeCcdCommitmentEnds`, and `timeTerminated`, with respect to the current time.
LifecycleDetails CcdCommitmentLifecycleDetailsEnum `mandatory:"true" json:"lifecycleDetails"`
// The commercial workflow of the associated CCD offer.
SourceType CcdOfferSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// The reclaim term copied from the offer when the commitment is created. The value is measured in `reclaimTermUnit`.
ReclaimTerm *int64 `mandatory:"false" json:"reclaimTerm"`
// The unit used to measure `reclaimTerm`, copied from the offer when the commitment is created.
ReclaimTermUnit CcdOfferReclaimTermUnitEnum `mandatory:"false" json:"reclaimTermUnit,omitempty"`
// The CCD commitment name. The name will be unique across the subscription for which the CCD commitment has been created. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The tenancy OCID that you want to apply filler usage to.
FillerTenancyId *string `mandatory:"false" json:"fillerTenancyId"`
// The filler tenancy home region.
FillerTenancyHomeRegion *string `mandatory:"false" json:"fillerTenancyHomeRegion"`
UsageEligibility *UsageEligibility `mandatory:"false" json:"usageEligibility"`
// The CCD commitment's current state, which always defaults to `Active`. For a more accurate detailed state,
// refer to `lifecycleDetails`.
LifecycleState CcdCommitmentLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The list of SKUs associated with the commitment and their prices in all currency codes.
SkuQuantityPriceModel []CommittedSkuQuantityPriceModel `mandatory:"false" json:"skuQuantityPriceModel"`
// The secondary SKUs associated with the main SKU.
SecondarySkus []SecondarySkus `mandatory:"false" json:"secondarySkus"`
// Date and time the CCD was created. The format is defined by RFC 3339.
// Example: `2022-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date and time the CCD was updated lastly. The format is defined by RFC 3339.
// Example: `2025-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Date and time the CCD was terminated. The format is defined by RFC 3339.
// Example: `2022-01-25T21:10:29.600Z`
TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// Entity/User who lastly updated the ccdCommitment.
LastUpdatedBy *string `mandatory:"false" json:"lastUpdatedBy"`
// The entity that created the CCD commitment.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Entity/User who approved the ccdCommitment.
ApprovedBy *string `mandatory:"false" json:"approvedBy"`
}
func (m CcdCommitmentSummary) String() string
func (m CcdCommitmentSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CcdCommitmentsClient a client for CcdCommitments
type CcdCommitmentsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewCcdCommitmentsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client CcdCommitmentsClient, err error)
NewCcdCommitmentsClientWithConfigurationProvider Creates a new default CcdCommitments client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewCcdCommitmentsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client CcdCommitmentsClient, err error)
NewCcdCommitmentsClientWithOboToken Creates a new default CcdCommitments client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *CcdCommitmentsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client CcdCommitmentsClient) CreateCcdCommitment(ctx context.Context, request CreateCcdCommitmentRequest) (response CreateCcdCommitmentResponse, err error)
CreateCcdCommitment Request to create a new CCD commitment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/CreateCcdCommitment.go.html to see an example of how to use CreateCcdCommitment API. A default retry strategy applies to this operation CreateCcdCommitment()
func (client CcdCommitmentsClient) DeleteCcdCommitment(ctx context.Context, request DeleteCcdCommitmentRequest) (response DeleteCcdCommitmentResponse, err error)
DeleteCcdCommitment Terminates the CCD commitment. You can't terminate an already canceled or ended commitment. If the CCD commitment has already started based on `timeCcdCommitmentStarts`, then you can only terminate within a week of its effective `timeCcdCommitmentStarts` time.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/DeleteCcdCommitment.go.html to see an example of how to use DeleteCcdCommitment API. A default retry strategy applies to this operation DeleteCcdCommitment()
func (client CcdCommitmentsClient) GetCcdCommitment(ctx context.Context, request GetCcdCommitmentRequest) (response GetCcdCommitmentResponse, err error)
GetCcdCommitment Gets the CCD commitment using the CCD commitment ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/GetCcdCommitment.go.html to see an example of how to use GetCcdCommitment API. A default retry strategy applies to this operation GetCcdCommitment()
func (client CcdCommitmentsClient) ListCcdCommitments(ctx context.Context, request ListCcdCommitmentsRequest) (response ListCcdCommitmentsResponse, err error)
ListCcdCommitments Lists the CCD commitments.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/ListCcdCommitments.go.html to see an example of how to use ListCcdCommitments API. A default retry strategy applies to this operation ListCcdCommitments()
func (client *CcdCommitmentsClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client CcdCommitmentsClient) UpdateCcdCommitment(ctx context.Context, request UpdateCcdCommitmentRequest) (response UpdateCcdCommitmentResponse, err error)
UpdateCcdCommitment Updates the free-form tags, defined tags, or both on a CCD commitment. Commercial commitment attributes are immutable.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/UpdateCcdCommitment.go.html to see an example of how to use UpdateCcdCommitment API. A default retry strategy applies to this operation UpdateCcdCommitment()
CcdOffer The created CCD offer details.
type CcdOffer struct {
// The CCD offer OCID.
Id *string `mandatory:"true" json:"id"`
// The CCD offer name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The SKU part number (prefaced with "B") the CCD is associated with.
Sku *string `mandatory:"true" json:"sku"`
// The canonical SKU display name.
SkuDisplayName *string `mandatory:"true" json:"skuDisplayName"`
// The canonical billing metric.
SkuMetric *string `mandatory:"true" json:"skuMetric"`
// The minimum quantity of the primary SKU committed to the CCD offer.
// For FLEX offers, minQuantity and maxQuantity must both be equal if maxQuantity provided.
MinQuantity *int64 `mandatory:"true" json:"minQuantity"`
// The number of terms the offer is applicable to.
Term *int `mandatory:"true" json:"term"`
// The discount percentage applicable to the CCD offer, represented as a decimal string
// from 0 through 100 inclusive.
DiscountPct *string `mandatory:"true" json:"discountPct"`
// The CCD offer type.
TypeOfOffer CcdOfferTypeOfOfferEnum `mandatory:"false" json:"typeOfOffer,omitempty"`
// The commercial workflow that created the CCD offer/commitment. This value is immutable.
SourceType CcdOfferSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// The reclaim term for an offer, measured in `reclaimTermUnit`.
ReclaimTerm *int64 `mandatory:"false" json:"reclaimTerm"`
// The unit used to measure `reclaimTerm`.
ReclaimTermUnit CcdOfferReclaimTermUnitEnum `mandatory:"false" json:"reclaimTermUnit,omitempty"`
// Entity/User who lastly updated the ccdOffer.
LastUpdatedBy *string `mandatory:"false" json:"lastUpdatedBy"`
// Entity/User who created the ccdOffer.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Sales order document number.
OrderDocumentNumber *string `mandatory:"false" json:"orderDocumentNumber"`
// The targeted customer segment.
CustomerSegment CcdOfferCustomerSegmentEnum `mandatory:"false" json:"customerSegment,omitempty"`
// Enable or disable filler usage if the customer usage quantity is below the minimum quantity, and you want metering to fill
// in usages to meet the minimum quantity.
IsFillerUsageEnable *bool `mandatory:"false" json:"isFillerUsageEnable"`
// Defines where the filler usage is reported
ReportingRegion *string `mandatory:"false" json:"reportingRegion"`
// The maximum quantity of the primary SKU committed to the CCD offer.
// For FLEX offers if provided, it must equal minQuantity.
MaxQuantity *int64 `mandatory:"false" json:"maxQuantity"`
// The term units.
Unit CcdOfferUnitEnum `mandatory:"false" json:"unit,omitempty"`
// The SKU list price in all currency codes.
ExternalPriceOfSku []SkuExternalPriceModel `mandatory:"false" json:"externalPriceOfSku"`
OfferRestriction *OfferRestriction `mandatory:"false" json:"offerRestriction"`
// The polymorphic bundled SKU definitions. Every bundled SKU in an offer must use the same `quantityRule`; don't mix
// `FIXED_RATIO` and `CUSTOMER_SELECTED` bundled SKUs in one offer. An offer can contain at most five SKUs in total,
// including the primary SKU.
BundleSkus []BundleSku `mandatory:"false" json:"bundleSkus"`
// Always defaults to `Active`. For the accurate resource state,
// refer to the `lifecycleDetails` property value.
LifecycleState CcdOfferLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The CCD offer's detailed current state. The state value is determined by `timeCcdOfferStarts`,
// `timeCcdOfferEnds`, and `timeTerminated` with respect to the current time.
LifecycleDetails CcdOfferLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// Date and time the CCD was created. The format is defined by RFC 3339.
// Example: `2022-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date and time the CCD was terminated. The format is defined by RFC 3339.
// Example: `2022-01-25T21:10:29.600Z`
TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
// Date and time the CCD was updated lastly. The format is defined by RFC 3339.
// Example: `2025-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The inclusive date the CCD offer will be effective. The format is defined by RFC 3339.
TimeCcdOfferStarts *common.SDKTime `mandatory:"false" json:"timeCcdOfferStarts"`
// The inclusive time when the CCD offer is no longer in effect, and must be after `timeCcdOfferStarts`.
// The format is defined by RFC 3339.
TimeCcdOfferEnds *common.SDKTime `mandatory:"false" json:"timeCcdOfferEnds"`
// Currency code of listPrice associated with primary product/sku. This will be always null.
// Please refer `externalPriceOfSku` to know product/sku's associated list price in its currency code.
CurrencyCode *string `mandatory:"false" json:"currencyCode"`
// ListPrice of a sku.
// Please refer `externalPriceOfSku` to know product/sku's associated list price in its currency code.
ListPrice *string `mandatory:"false" json:"listPrice"`
// The subscription OCID if a this is dedicated CCD offer for a customer.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// The root compartment OCID of the customer's tenancy if offer is dedicated to a particular customer only.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
}
func (m CcdOffer) String() string
func (m *CcdOffer) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CcdOffer) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CcdOfferCollection CCD offer summary items.
type CcdOfferCollection struct {
// The CCD offer summary.
Items []CcdOfferSummary `mandatory:"true" json:"items"`
}
func (m CcdOfferCollection) String() string
func (m CcdOfferCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CcdOfferCustomerSegmentEnum Enum with underlying type: string
type CcdOfferCustomerSegmentEnum string
Set of constants representing the allowable values for CcdOfferCustomerSegmentEnum
const (
CcdOfferCustomerSegmentInternal CcdOfferCustomerSegmentEnum = "INTERNAL"
CcdOfferCustomerSegmentExternal CcdOfferCustomerSegmentEnum = "EXTERNAL"
)
func GetCcdOfferCustomerSegmentEnumValues() []CcdOfferCustomerSegmentEnum
GetCcdOfferCustomerSegmentEnumValues Enumerates the set of values for CcdOfferCustomerSegmentEnum
func GetMappingCcdOfferCustomerSegmentEnum(val string) (CcdOfferCustomerSegmentEnum, bool)
GetMappingCcdOfferCustomerSegmentEnum performs case Insensitive comparison on enum value and return the desired enum
CcdOfferLifecycleDetailsEnum Enum with underlying type: string
type CcdOfferLifecycleDetailsEnum string
Set of constants representing the allowable values for CcdOfferLifecycleDetailsEnum
const (
CcdOfferLifecycleDetailsScheduled CcdOfferLifecycleDetailsEnum = "SCHEDULED"
CcdOfferLifecycleDetailsCurrent CcdOfferLifecycleDetailsEnum = "CURRENT"
CcdOfferLifecycleDetailsCanceled CcdOfferLifecycleDetailsEnum = "CANCELED"
CcdOfferLifecycleDetailsEnded CcdOfferLifecycleDetailsEnum = "ENDED"
)
func GetCcdOfferLifecycleDetailsEnumValues() []CcdOfferLifecycleDetailsEnum
GetCcdOfferLifecycleDetailsEnumValues Enumerates the set of values for CcdOfferLifecycleDetailsEnum
func GetMappingCcdOfferLifecycleDetailsEnum(val string) (CcdOfferLifecycleDetailsEnum, bool)
GetMappingCcdOfferLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
CcdOfferLifecycleStateEnum Enum with underlying type: string
type CcdOfferLifecycleStateEnum string
Set of constants representing the allowable values for CcdOfferLifecycleStateEnum
const (
CcdOfferLifecycleStateActive CcdOfferLifecycleStateEnum = "ACTIVE"
)
func GetCcdOfferLifecycleStateEnumValues() []CcdOfferLifecycleStateEnum
GetCcdOfferLifecycleStateEnumValues Enumerates the set of values for CcdOfferLifecycleStateEnum
func GetMappingCcdOfferLifecycleStateEnum(val string) (CcdOfferLifecycleStateEnum, bool)
GetMappingCcdOfferLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
CcdOfferReclaimTermUnitEnum Enum with underlying type: string
type CcdOfferReclaimTermUnitEnum string
Set of constants representing the allowable values for CcdOfferReclaimTermUnitEnum
const (
CcdOfferReclaimTermUnitDays CcdOfferReclaimTermUnitEnum = "DAYS"
)
func GetCcdOfferReclaimTermUnitEnumValues() []CcdOfferReclaimTermUnitEnum
GetCcdOfferReclaimTermUnitEnumValues Enumerates the set of values for CcdOfferReclaimTermUnitEnum
func GetMappingCcdOfferReclaimTermUnitEnum(val string) (CcdOfferReclaimTermUnitEnum, bool)
GetMappingCcdOfferReclaimTermUnitEnum performs case Insensitive comparison on enum value and return the desired enum
CcdOfferSourceTypeEnum Enum with underlying type: string
type CcdOfferSourceTypeEnum string
Set of constants representing the allowable values for CcdOfferSourceTypeEnum
const (
CcdOfferSourceTypeContractCommitment CcdOfferSourceTypeEnum = "CONTRACT_COMMITMENT"
CcdOfferSourceTypeContractOffer CcdOfferSourceTypeEnum = "CONTRACT_OFFER"
CcdOfferSourceTypeFlex CcdOfferSourceTypeEnum = "FLEX"
CcdOfferSourceTypeOciGenerated CcdOfferSourceTypeEnum = "OCI_GENERATED"
)
func GetCcdOfferSourceTypeEnumValues() []CcdOfferSourceTypeEnum
GetCcdOfferSourceTypeEnumValues Enumerates the set of values for CcdOfferSourceTypeEnum
func GetMappingCcdOfferSourceTypeEnum(val string) (CcdOfferSourceTypeEnum, bool)
GetMappingCcdOfferSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CcdOfferSummary CCD offer details.
type CcdOfferSummary struct {
// The CCD offer resource OCID.
Id *string `mandatory:"true" json:"id"`
// The CCD offer name. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The SKU part number (prefaced with "B") the CCD is associated with.
Sku *string `mandatory:"true" json:"sku"`
// The canonical SKU display name.
SkuDisplayName *string `mandatory:"true" json:"skuDisplayName"`
// The canonical billing metric.
SkuMetric *string `mandatory:"true" json:"skuMetric"`
// The minimum quantity of the primary SKU committed to the CCD offer.
// For FLEX offers, minQuantity and maxQuantity must both be equal if maxQuantity provided.
MinQuantity *int64 `mandatory:"true" json:"minQuantity"`
// The number of terms the offer is applicable to.
Term *int `mandatory:"true" json:"term"`
// The discount percentage applicable to the CCD offer, represented as a decimal string
// from 0 through 100 inclusive.
DiscountPct *string `mandatory:"true" json:"discountPct"`
// The subscription OCID for which the dedicated CCD offer has been created.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// The root compartment OCID of the customer's tenancy.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The created CCD offer type.
TypeOfOffer CcdOfferSummaryTypeOfOfferEnum `mandatory:"false" json:"typeOfOffer,omitempty"`
// The commercial workflow that created the CCD offer.
SourceType CcdOfferSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// The reclaim term for an offer, measured in `reclaimTermUnit`.
ReclaimTerm *int64 `mandatory:"false" json:"reclaimTerm"`
// The unit used to measure `reclaimTerm`.
ReclaimTermUnit CcdOfferReclaimTermUnitEnum `mandatory:"false" json:"reclaimTermUnit,omitempty"`
// The targeted customer segment.
CustomerSegment CcdOfferSummaryCustomerSegmentEnum `mandatory:"false" json:"customerSegment,omitempty"`
// Enable or disable filler usage if the customer usage quantity is below the minimum quantity, and you want metering to fill
// in usages to meet the minimum quantity.
IsFillerUsageEnable *bool `mandatory:"false" json:"isFillerUsageEnable"`
// Entity/User who lastly updated the ccdOffer.
LastUpdatedBy *string `mandatory:"false" json:"lastUpdatedBy"`
// Entity/User who created the ccdOffer.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Sales order document number.
OrderDocumentNumber *string `mandatory:"false" json:"orderDocumentNumber"`
// Defines where the filler usage is reported
ReportingRegion *string `mandatory:"false" json:"reportingRegion"`
// The maximum quantity of the primary SKU committed to the CCD offer.
// For FLEX offers if provided, it must equal minQuantity.
MaxQuantity *int64 `mandatory:"false" json:"maxQuantity"`
// The term units.
Unit CcdOfferSummaryUnitEnum `mandatory:"false" json:"unit,omitempty"`
OfferRestriction *OfferRestriction `mandatory:"false" json:"offerRestriction"`
// The polymorphic bundled SKU definitions. Every bundled SKU in an offer must use the same `quantityRule`; don't mix
// `FIXED_RATIO` and `CUSTOMER_SELECTED` bundled SKUs in one offer. An offer can contain at most five SKUs in total,
// including the primary SKU.
BundleSkus []BundleSku `mandatory:"false" json:"bundleSkus"`
// The SKU list price in all currency codes.
ExternalPriceOfSku []SkuExternalPriceModel `mandatory:"false" json:"externalPriceOfSku"`
// The CCD offer's current state. This always defaults to `Active`. For the accurate resource state,
// refer to the `lifecycleDetails` property value.
LifecycleState CcdOfferLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The CCD offer's detailed current state. The state value is determined by `timeCcdOfferStarts`,
// `timeCcdOfferEnds`, and `timeTerminated` with respect to the current time.
LifecycleDetails CcdOfferLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// Date and time the CCD was created. The format is defined by RFC 3339.
// Example: `2022-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date and time the CCD was updated lastly. The format is defined by RFC 3339.
// Example: `2025-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Date and time the CCD was terminated. The format is defined by RFC 3339.
// Example: `2022-01-25T21:10:29.600Z`
TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The inclusive date the CCD offer will be effective. The format is defined by RFC 3339.
TimeCcdOfferStarts *common.SDKTime `mandatory:"false" json:"timeCcdOfferStarts"`
// The inclusive time when the CCD offer is no longer in effect. The format is defined by RFC 3339.
TimeCcdOfferEnds *common.SDKTime `mandatory:"false" json:"timeCcdOfferEnds"`
// Currency code of listPrice associated with primary product/sku. This will be always null.
// Please refer `externalPriceOfSku` to know product/sku's associated list price in its currency code.
CurrencyCode *string `mandatory:"false" json:"currencyCode"`
// ListPrice of a sku.
// Please refer `externalPriceOfSku` to know product/sku's associated list price in its currency code.
ListPrice *string `mandatory:"false" json:"listPrice"`
}
func (m CcdOfferSummary) String() string
func (m *CcdOfferSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CcdOfferSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CcdOfferSummaryCustomerSegmentEnum Enum with underlying type: string
type CcdOfferSummaryCustomerSegmentEnum string
Set of constants representing the allowable values for CcdOfferSummaryCustomerSegmentEnum
const (
CcdOfferSummaryCustomerSegmentInternal CcdOfferSummaryCustomerSegmentEnum = "INTERNAL"
CcdOfferSummaryCustomerSegmentExternal CcdOfferSummaryCustomerSegmentEnum = "EXTERNAL"
)
func GetCcdOfferSummaryCustomerSegmentEnumValues() []CcdOfferSummaryCustomerSegmentEnum
GetCcdOfferSummaryCustomerSegmentEnumValues Enumerates the set of values for CcdOfferSummaryCustomerSegmentEnum
func GetMappingCcdOfferSummaryCustomerSegmentEnum(val string) (CcdOfferSummaryCustomerSegmentEnum, bool)
GetMappingCcdOfferSummaryCustomerSegmentEnum performs case Insensitive comparison on enum value and return the desired enum
CcdOfferSummaryTypeOfOfferEnum Enum with underlying type: string
type CcdOfferSummaryTypeOfOfferEnum string
Set of constants representing the allowable values for CcdOfferSummaryTypeOfOfferEnum
const (
CcdOfferSummaryTypeOfOfferStandard CcdOfferSummaryTypeOfOfferEnum = "STANDARD"
CcdOfferSummaryTypeOfOfferCustom CcdOfferSummaryTypeOfOfferEnum = "CUSTOM"
CcdOfferSummaryTypeOfOfferPrivate CcdOfferSummaryTypeOfOfferEnum = "PRIVATE"
CcdOfferSummaryTypeOfOfferContractual CcdOfferSummaryTypeOfOfferEnum = "CONTRACTUAL"
CcdOfferSummaryTypeOfOfferFlex CcdOfferSummaryTypeOfOfferEnum = "FLEX"
)
func GetCcdOfferSummaryTypeOfOfferEnumValues() []CcdOfferSummaryTypeOfOfferEnum
GetCcdOfferSummaryTypeOfOfferEnumValues Enumerates the set of values for CcdOfferSummaryTypeOfOfferEnum
func GetMappingCcdOfferSummaryTypeOfOfferEnum(val string) (CcdOfferSummaryTypeOfOfferEnum, bool)
GetMappingCcdOfferSummaryTypeOfOfferEnum performs case Insensitive comparison on enum value and return the desired enum
CcdOfferSummaryUnitEnum Enum with underlying type: string
type CcdOfferSummaryUnitEnum string
Set of constants representing the allowable values for CcdOfferSummaryUnitEnum
const (
CcdOfferSummaryUnitMonths CcdOfferSummaryUnitEnum = "MONTHS"
CcdOfferSummaryUnitYears CcdOfferSummaryUnitEnum = "YEARS"
CcdOfferSummaryUnitDays CcdOfferSummaryUnitEnum = "DAYS"
CcdOfferSummaryUnitHours CcdOfferSummaryUnitEnum = "HOURS"
)
func GetCcdOfferSummaryUnitEnumValues() []CcdOfferSummaryUnitEnum
GetCcdOfferSummaryUnitEnumValues Enumerates the set of values for CcdOfferSummaryUnitEnum
func GetMappingCcdOfferSummaryUnitEnum(val string) (CcdOfferSummaryUnitEnum, bool)
GetMappingCcdOfferSummaryUnitEnum performs case Insensitive comparison on enum value and return the desired enum
CcdOfferTypeOfOfferEnum Enum with underlying type: string
type CcdOfferTypeOfOfferEnum string
Set of constants representing the allowable values for CcdOfferTypeOfOfferEnum
const (
CcdOfferTypeOfOfferStandard CcdOfferTypeOfOfferEnum = "STANDARD"
CcdOfferTypeOfOfferCustom CcdOfferTypeOfOfferEnum = "CUSTOM"
CcdOfferTypeOfOfferPrivate CcdOfferTypeOfOfferEnum = "PRIVATE"
CcdOfferTypeOfOfferContractual CcdOfferTypeOfOfferEnum = "CONTRACTUAL"
CcdOfferTypeOfOfferFlex CcdOfferTypeOfOfferEnum = "FLEX"
)
func GetCcdOfferTypeOfOfferEnumValues() []CcdOfferTypeOfOfferEnum
GetCcdOfferTypeOfOfferEnumValues Enumerates the set of values for CcdOfferTypeOfOfferEnum
func GetMappingCcdOfferTypeOfOfferEnum(val string) (CcdOfferTypeOfOfferEnum, bool)
GetMappingCcdOfferTypeOfOfferEnum performs case Insensitive comparison on enum value and return the desired enum
CcdOfferUnitEnum Enum with underlying type: string
type CcdOfferUnitEnum string
Set of constants representing the allowable values for CcdOfferUnitEnum
const (
CcdOfferUnitMonths CcdOfferUnitEnum = "MONTHS"
CcdOfferUnitYears CcdOfferUnitEnum = "YEARS"
CcdOfferUnitDays CcdOfferUnitEnum = "DAYS"
CcdOfferUnitHours CcdOfferUnitEnum = "HOURS"
)
func GetCcdOfferUnitEnumValues() []CcdOfferUnitEnum
GetCcdOfferUnitEnumValues Enumerates the set of values for CcdOfferUnitEnum
func GetMappingCcdOfferUnitEnum(val string) (CcdOfferUnitEnum, bool)
GetMappingCcdOfferUnitEnum performs case Insensitive comparison on enum value and return the desired enum
CcdOffersClient a client for CcdOffers
type CcdOffersClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewCcdOffersClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client CcdOffersClient, err error)
NewCcdOffersClientWithConfigurationProvider Creates a new default CcdOffers client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewCcdOffersClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client CcdOffersClient, err error)
NewCcdOffersClientWithOboToken Creates a new default CcdOffers client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *CcdOffersClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client CcdOffersClient) GetCcdOffer(ctx context.Context, request GetCcdOfferRequest) (response GetCcdOfferResponse, err error)
GetCcdOffer Get a particular CCD offer details.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/GetCcdOffer.go.html to see an example of how to use GetCcdOffer API. A default retry strategy applies to this operation GetCcdOffer()
func (client CcdOffersClient) ListCcdOffers(ctx context.Context, request ListCcdOffersRequest) (response ListCcdOffersResponse, err error)
ListCcdOffers Lists the CCD offers for the requested subscription. A FLEX offer is no longer returned after it is either accepted, rejected or expired.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/ListCcdOffers.go.html to see an example of how to use ListCcdOffers API. A default retry strategy applies to this operation ListCcdOffers()
func (client *CcdOffersClient) SetRegion(region string)
SetRegion overrides the region of this client.
CommittedSkuQuantityPriceModel The committed SKU, quantity, and its price information model.
type CommittedSkuQuantityPriceModel struct {
// The SKU part number (prefaced with "B") associated with the committed CCD.
Sku *string `mandatory:"false" json:"sku"`
// The canonical SKU display name derived from the associated offer.
SkuDisplayName *string `mandatory:"false" json:"skuDisplayName"`
// The canonical billing metric derived from the associated offer.
SkuMetric *string `mandatory:"false" json:"skuMetric"`
// True if the SKU is the primary SKU of a CCD offer, otheriwse, false.
IsMainSku *bool `mandatory:"false" json:"isMainSku"`
// The SKU quantity that's getting committed.
Quantity *int64 `mandatory:"false" json:"quantity"`
// The pricing model associated with the currency code.
CurrencyCodeLocalization []CurrencyCodeLocalization `mandatory:"false" json:"currencyCodeLocalization"`
}
func (m CommittedSkuQuantityPriceModel) String() string
func (m CommittedSkuQuantityPriceModel) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCcdCommitmentDetails CCD commitment creation details.
type CreateCcdCommitmentDetails struct {
// The hourly quantity that the customer is committing to a CCD offer's main SKU.
// For FLEX offers, this quantity must equal the CCD offer's minQuantity and maxQuantity when both are provided.
// For example, if the quantity is 1000, then you are committing to a 1000 usage quantity value per hour.
Quantity *int64 `mandatory:"true" json:"quantity"`
// The CCD commitment name. Ensure the name is unique across subscription IDs. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The subscription OCID value the CCD offer is applicable to.
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
// The compartment OCID where you want to create the CCD commitment.
// Must be the root compartment OCID of a parent tenancy (if part of an organization), or a standalone tenancy to which the subscription is associated.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The inclusive date and time when the CCD commitment will be effective.
// The date and time must be rounded up to the exact hour, and must be in the future. The format is defined by RFC 3339.
// For example, if you want to commit to a CCD on 2025-06-01 12:00:00, you should create a request any time before
// 2025-06-01 12:00:00. You can only create CCD for a Scheduled or Current CCD offer.
TimeCcdCommitmentStarts *common.SDKTime `mandatory:"true" json:"timeCcdCommitmentStarts"`
// The tenancy OCID you want to apply filler usage to.
FillerTenancyId *string `mandatory:"false" json:"fillerTenancyId"`
UsageEligibility *UsageEligibility `mandatory:"false" json:"usageEligibility"`
// The bundled SKUs selected for this commitment. Supply `quantity` only for components whose offer quantity rule is `CUSTOMER_SELECTED`.
SecondarySkus []SecondarySkus `mandatory:"false" json:"secondarySkus"`
// The exclusive time the CCD commitment ends. The time gets computed using `timeCcdCommitmentStarts` from the `ccdCommitment`,
// and the minimum commitment term associated with `CcdOffer`. The default value is set as null at the time of CCD commitment creation.
TimeCcdCommitmentEnds *common.SDKTime `mandatory:"false" json:"timeCcdCommitmentEnds"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateCcdCommitmentDetails) String() string
func (m CreateCcdCommitmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCcdCommitmentRequest wrapper for the CreateCcdCommitment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/CreateCcdCommitment.go.html to see an example of how to use CreateCcdCommitmentRequest.
type CreateCcdCommitmentRequest struct {
// CCD offer OCID.
// If you're trying to commit against the CCD offer, ensure that the CCD offer's `lifecycleDetails` field value is Current or Scheduled.
// You can only sign up for a current or scheduled CCD offer, but not for any canceled, or ended CCD offer.
CcdOfferId *string `mandatory:"true" contributesTo:"query" name:"ccdOfferId"`
// The create CCD commitment details model.
CreateCcdCommitmentDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateCcdCommitmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCcdCommitmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCcdCommitmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCcdCommitmentRequest) String() string
func (request CreateCcdCommitmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCcdCommitmentResponse wrapper for the CreateCcdCommitment operation
type CreateCcdCommitmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The CcdCommitment instance
CcdCommitment `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateCcdCommitmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCcdCommitmentResponse) String() string
CurrencyCodeLocalization The currency code and its listing price.
type CurrencyCodeLocalization struct {
// The currency code.
CurrencyCode *string `mandatory:"false" json:"currencyCode"`
// The pricing model associated with the currency code.
Prices []Prices `mandatory:"false" json:"prices"`
}
func (m CurrencyCodeLocalization) String() string
func (m CurrencyCodeLocalization) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CustomerSelectedBundleSku A bundle SKU whose quantity is selected by the customer within the configured range. For FLEX offers, the maxQuantity should be equal to minQuantity if provided.
type CustomerSelectedBundleSku struct {
// The bundled SKU part number (prefaced with "B"). For example, the "E4 MEMORY" SKU will be bundled with the main "E4 OCPUs" SKU.
Sku *string `mandatory:"true" json:"sku"`
// The minimum quantity the customer can select for this bundled SKU.
// For FLEX offers, minQuantity and maxQuantity must be equal if maxQuantity provided.
MinQuantity *int64 `mandatory:"true" json:"minQuantity"`
// The SKU display name is derived by CCD. If CCD cannot derive a unique value, it uses the caller-provided value.
SkuDisplayName *string `mandatory:"false" json:"skuDisplayName"`
// The SKU billing metric is derived by CCD. If CCD cannot derive a unique value, it uses the caller-provided value.
SkuMetric *string `mandatory:"false" json:"skuMetric"`
// List price of a SKU. Only set this property if the product or SKU is private. Tier pricing SKUs aren't supported.
ListPrice *string `mandatory:"false" json:"listPrice"`
// The currency code of `listPrice` associated with the product or SKU. Only set this property if the product or SKU is private.
// Tier pricing SKUs aren't supported.
CurrencyCode *string `mandatory:"false" json:"currencyCode"`
// The maximum quantity the customer can select for this bundled SKU.
// For FLEX offers must be equal to minQuantity if provided.
MaxQuantity *int64 `mandatory:"false" json:"maxQuantity"`
}
func (m CustomerSelectedBundleSku) GetCurrencyCode() *string
GetCurrencyCode returns CurrencyCode
func (m CustomerSelectedBundleSku) GetListPrice() *string
GetListPrice returns ListPrice
func (m CustomerSelectedBundleSku) GetSku() *string
GetSku returns Sku
func (m CustomerSelectedBundleSku) GetSkuDisplayName() *string
GetSkuDisplayName returns SkuDisplayName
func (m CustomerSelectedBundleSku) GetSkuMetric() *string
GetSkuMetric returns SkuMetric
func (m CustomerSelectedBundleSku) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CustomerSelectedBundleSku) String() string
func (m CustomerSelectedBundleSku) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteCcdCommitmentRequest wrapper for the DeleteCcdCommitment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/DeleteCcdCommitment.go.html to see an example of how to use DeleteCcdCommitmentRequest.
type DeleteCcdCommitmentRequest struct {
// CCD commitment OCID.
CcdCommitmentId *string `mandatory:"true" contributesTo:"path" name:"ccdCommitmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// is updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteCcdCommitmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCcdCommitmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCcdCommitmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCcdCommitmentRequest) String() string
func (request DeleteCcdCommitmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteCcdCommitmentResponse wrapper for the DeleteCcdCommitment operation
type DeleteCcdCommitmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteCcdCommitmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCcdCommitmentResponse) String() string
FixedRatioBundleSku A bundle SKU whose quantity is derived from the primary SKU quantity using a fixed ratio.
type FixedRatioBundleSku struct {
// The bundled SKU part number (prefaced with "B"). For example, the "E4 MEMORY" SKU will be bundled with the main "E4 OCPUs" SKU.
Sku *string `mandatory:"true" json:"sku"`
// The primary-to-bundled SKU quantity ratio.
Ratio *string `mandatory:"true" json:"ratio"`
// The SKU display name is derived by CCD. If CCD cannot derive a unique value, it uses the caller-provided value.
SkuDisplayName *string `mandatory:"false" json:"skuDisplayName"`
// The SKU billing metric is derived by CCD. If CCD cannot derive a unique value, it uses the caller-provided value.
SkuMetric *string `mandatory:"false" json:"skuMetric"`
// List price of a SKU. Only set this property if the product or SKU is private. Tier pricing SKUs aren't supported.
ListPrice *string `mandatory:"false" json:"listPrice"`
// The currency code of `listPrice` associated with the product or SKU. Only set this property if the product or SKU is private.
// Tier pricing SKUs aren't supported.
CurrencyCode *string `mandatory:"false" json:"currencyCode"`
}
func (m FixedRatioBundleSku) GetCurrencyCode() *string
GetCurrencyCode returns CurrencyCode
func (m FixedRatioBundleSku) GetListPrice() *string
GetListPrice returns ListPrice
func (m FixedRatioBundleSku) GetSku() *string
GetSku returns Sku
func (m FixedRatioBundleSku) GetSkuDisplayName() *string
GetSkuDisplayName returns SkuDisplayName
func (m FixedRatioBundleSku) GetSkuMetric() *string
GetSkuMetric returns SkuMetric
func (m FixedRatioBundleSku) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FixedRatioBundleSku) String() string
func (m FixedRatioBundleSku) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetCcdCommitmentRequest wrapper for the GetCcdCommitment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/GetCcdCommitment.go.html to see an example of how to use GetCcdCommitmentRequest.
type GetCcdCommitmentRequest struct {
// CCD commitment OCID.
CcdCommitmentId *string `mandatory:"true" contributesTo:"path" name:"ccdCommitmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetCcdCommitmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCcdCommitmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCcdCommitmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCcdCommitmentRequest) String() string
func (request GetCcdCommitmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetCcdCommitmentResponse wrapper for the GetCcdCommitment operation
type GetCcdCommitmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The CcdCommitment instance
CcdCommitment `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetCcdCommitmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCcdCommitmentResponse) String() string
GetCcdOfferRequest wrapper for the GetCcdOffer operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/GetCcdOffer.go.html to see an example of how to use GetCcdOfferRequest.
type GetCcdOfferRequest struct {
// The CCD offer OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
CcdOfferId *string `mandatory:"true" contributesTo:"path" name:"ccdOfferId"`
// The subscription ID associated with the CCD offer.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetCcdOfferRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCcdOfferRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCcdOfferRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCcdOfferRequest) String() string
func (request GetCcdOfferRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetCcdOfferResponse wrapper for the GetCcdOffer operation
type GetCcdOfferResponse struct {
// The underlying http response
RawResponse *http.Response
// The CcdOffer instance
CcdOffer `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetCcdOfferResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCcdOfferResponse) String() string
ListCcdCommitmentsRequest wrapper for the ListCcdCommitments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/ListCcdCommitments.go.html to see an example of how to use ListCcdCommitmentsRequest.
type ListCcdCommitmentsRequest struct {
// The subscription ID associated with the CCD offer.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// The OCID of the compartment (remember that the tenancy is simply the root compartment).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The lifecycle of a CCD commitment that's being requested, which always defaults to Active. If you want to filter by
// scheduled, current, awaiting provisioning, canceled, or ended, use the `lifecycleDetails` query parameter.
LifecycleState CcdCommitmentLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The lifecycle details of a CCD commitment that's being requested. The accepted values are Scheduled, Current,
// Awaiting Provisioning, Canceled, or Ended.
// If a null or empty value is passed, it will return for all resources.
LifecycleDetails CcdCommitmentLifecycleDetailsEnum `mandatory:"false" contributesTo:"query" name:"lifecycleDetails" omitEmpty:"true"`
// Filter CCD offers or commitments by the commercial workflow that created the associated offer.
SourceType CcdOfferSourceTypeEnum `mandatory:"false" contributesTo:"query" name:"sourceType" omitEmpty:"true"`
// The sort order to use, whether "asc" or "desc". By default, it is ascending.
SortOrder ListCcdCommitmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filter by the resource display name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The sort by field to use, whether "DISPLAYNAME" or "TIMECREATED". By default, it is TIMECREATED.
SortBy ListCcdCommitmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListCcdCommitmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCcdCommitmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCcdCommitmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCcdCommitmentsRequest) String() string
func (request ListCcdCommitmentsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListCcdCommitmentsResponse wrapper for the ListCcdCommitments operation
type ListCcdCommitmentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of CcdCommitmentCollection instances
CcdCommitmentCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListCcdCommitmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCcdCommitmentsResponse) String() string
ListCcdCommitmentsSortByEnum Enum with underlying type: string
type ListCcdCommitmentsSortByEnum string
Set of constants representing the allowable values for ListCcdCommitmentsSortByEnum
const (
ListCcdCommitmentsSortByDisplayname ListCcdCommitmentsSortByEnum = "DISPLAYNAME"
ListCcdCommitmentsSortByTimecreated ListCcdCommitmentsSortByEnum = "TIMECREATED"
)
func GetListCcdCommitmentsSortByEnumValues() []ListCcdCommitmentsSortByEnum
GetListCcdCommitmentsSortByEnumValues Enumerates the set of values for ListCcdCommitmentsSortByEnum
func GetMappingListCcdCommitmentsSortByEnum(val string) (ListCcdCommitmentsSortByEnum, bool)
GetMappingListCcdCommitmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCcdCommitmentsSortOrderEnum Enum with underlying type: string
type ListCcdCommitmentsSortOrderEnum string
Set of constants representing the allowable values for ListCcdCommitmentsSortOrderEnum
const (
ListCcdCommitmentsSortOrderAsc ListCcdCommitmentsSortOrderEnum = "ASC"
ListCcdCommitmentsSortOrderDesc ListCcdCommitmentsSortOrderEnum = "DESC"
)
func GetListCcdCommitmentsSortOrderEnumValues() []ListCcdCommitmentsSortOrderEnum
GetListCcdCommitmentsSortOrderEnumValues Enumerates the set of values for ListCcdCommitmentsSortOrderEnum
func GetMappingListCcdCommitmentsSortOrderEnum(val string) (ListCcdCommitmentsSortOrderEnum, bool)
GetMappingListCcdCommitmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListCcdOffersRequest wrapper for the ListCcdOffers operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/ListCcdOffers.go.html to see an example of how to use ListCcdOffersRequest.
type ListCcdOffersRequest struct {
// The subscription ID associated with the CCD offer.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// The OCID of the compartment (remember that the tenancy is simply the root compartment).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The life cycle of a CCD offer that's being requested, which always defaults to `Active`. If you want to filter by
// scheduled, current, canceled, or ended, use the `lifecycleDetails` query parameter.
LifecycleState CcdOfferLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The life cycle details of a CCD offer that's being requested. The accepted values are Scheduled, Current, Canceled, or Ended.
// If a null or empty value is passed, it will return for all resources.
LifecycleDetails CcdOfferLifecycleDetailsEnum `mandatory:"false" contributesTo:"query" name:"lifecycleDetails" omitEmpty:"true"`
// The CCD offer type to use when filtering results.
TypeOfOffer CcdOfferTypeOfOfferEnum `mandatory:"false" contributesTo:"query" name:"typeOfOffer" omitEmpty:"true"`
// Filter CCD offers or commitments by the commercial workflow that created the associated offer.
SourceType CcdOfferSourceTypeEnum `mandatory:"false" contributesTo:"query" name:"sourceType" omitEmpty:"true"`
// The sort order to use, whether "asc" or "desc". By default, it is ascending.
SortOrder ListCcdOffersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The sort by field to use, whether "DISPLAYNAME" or "TIMECREATED". By default, it is TIMECREATED.
SortBy ListCcdOffersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Filter by the resource display name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListCcdOffersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCcdOffersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCcdOffersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCcdOffersRequest) String() string
func (request ListCcdOffersRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListCcdOffersResponse wrapper for the ListCcdOffers operation
type ListCcdOffersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of CcdOfferCollection instances
CcdOfferCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListCcdOffersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCcdOffersResponse) String() string
ListCcdOffersSortByEnum Enum with underlying type: string
type ListCcdOffersSortByEnum string
Set of constants representing the allowable values for ListCcdOffersSortByEnum
const (
ListCcdOffersSortByDisplayname ListCcdOffersSortByEnum = "DISPLAYNAME"
ListCcdOffersSortByTimecreated ListCcdOffersSortByEnum = "TIMECREATED"
)
func GetListCcdOffersSortByEnumValues() []ListCcdOffersSortByEnum
GetListCcdOffersSortByEnumValues Enumerates the set of values for ListCcdOffersSortByEnum
func GetMappingListCcdOffersSortByEnum(val string) (ListCcdOffersSortByEnum, bool)
GetMappingListCcdOffersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCcdOffersSortOrderEnum Enum with underlying type: string
type ListCcdOffersSortOrderEnum string
Set of constants representing the allowable values for ListCcdOffersSortOrderEnum
const (
ListCcdOffersSortOrderAsc ListCcdOffersSortOrderEnum = "ASC"
ListCcdOffersSortOrderDesc ListCcdOffersSortOrderEnum = "DESC"
)
func GetListCcdOffersSortOrderEnumValues() []ListCcdOffersSortOrderEnum
GetListCcdOffersSortOrderEnumValues Enumerates the set of values for ListCcdOffersSortOrderEnum
func GetMappingListCcdOffersSortOrderEnum(val string) (ListCcdOffersSortOrderEnum, bool)
GetMappingListCcdOffersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
OfferRestriction CCD offer applicability restrictions.
type OfferRestriction struct {
// The region the CCD offer is applicable to.
// For example, a CCD offer applicable only to us-ashburn-1.
Region *string `mandatory:"false" json:"region"`
// The Availability Domain the CCD offer is applicable to.
// If you are setting `availabilityDomain`, ensure to also set the `region` property value.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The subscription OCIDs the CCD offer is applicable to.
SubscriptionIds []string `mandatory:"false" json:"subscriptionIds"`
}
func (m OfferRestriction) String() string
func (m OfferRestriction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Prices The SKU external listing price.
type Prices struct {
// Pricing model.
Model PricesModelEnum `mandatory:"false" json:"model,omitempty"`
// Currency value.
Value *string `mandatory:"false" json:"value"`
// The minimum quantity for tier pricing (exclusive). Only applicable for products that support range-based pricing.
RangeMin *string `mandatory:"false" json:"rangeMin"`
// The maximum quantity for tier pricing (inclusive). Only applicable for products that support range-based pricing.
RangeMax *string `mandatory:"false" json:"rangeMax"`
// The `rangeMin` and `rangeMax` unit of measurement (for example, "GB" or "TB").
RangeUnit *string `mandatory:"false" json:"rangeUnit"`
}
func (m Prices) String() string
func (m Prices) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PricesModelEnum Enum with underlying type: string
type PricesModelEnum string
Set of constants representing the allowable values for PricesModelEnum
const (
PricesModelPayAsYouGo PricesModelEnum = "PAY_AS_YOU_GO"
)
func GetMappingPricesModelEnum(val string) (PricesModelEnum, bool)
GetMappingPricesModelEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPricesModelEnumValues() []PricesModelEnum
GetPricesModelEnumValues Enumerates the set of values for PricesModelEnum
SecondarySkus A secondary SKU associated with a CCD commitment. Its quantity behavior is defined by the corresponding bundled SKU on the CCD offer.
type SecondarySkus struct {
// The secondary SKU part number (prefaced with "B"). For example, the "E4 MEMORY" SKU will be the secondary SKU with the main "E4 OCPUs" SKU.
// Must also be the same as `CcdOffers's` `bundleSkus` `sku` value.
Sku *string `mandatory:"true" json:"sku"`
// The canonical SKU display name derived from the associated offer. This property remains accepted in create and update
// requests for compatibility, but CCD uses the offer-derived value. Avoid entering confidential information.
SkuDisplayName *string `mandatory:"true" json:"skuDisplayName"`
// The canonical billing metric derived from the associated offer. This property remains accepted in create and update
// requests for compatibility, but CCD uses the offer-derived value.
SkuMetric *string `mandatory:"false" json:"skuMetric"`
// The resolved hourly commitment quantity for this secondary SKU. In create or update requests, this property is required
// when the corresponding offer component uses `CUSTOMER_SELECTED`, and the value must be within the offer component's
// minimum and maximum. For FLEX offers with `CUSTOMER_SELECTED`, this quantity must equal the offer component's `minQuantity`
// and, if defined, `maxQuantity`. For `FIXED_RATIO`, this property may be omitted because CCD derives it from the primary
// quantity and the offer-defined ratio. If an existing client supplies a quantity for `FIXED_RATIO`, the offer-defined ratio is authoritative.
Quantity *int64 `mandatory:"false" json:"quantity"`
}
func (m SecondarySkus) String() string
func (m SecondarySkus) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SkuExternalPriceModel The currency code and listing price.
type SkuExternalPriceModel struct {
// The SKU part number (prefaced with "B") the CCD is associated with.
Sku *string `mandatory:"false" json:"sku"`
// The pricing model associated with the currency code.
CurrencyCodeLocalization []CurrencyCodeLocalization `mandatory:"false" json:"currencyCodeLocalization"`
}
func (m SkuExternalPriceModel) String() string
func (m SkuExternalPriceModel) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateCcdCommitmentDetails Tag-only update details for a CCD commitment. At least one tag family must be supplied. An omitted tag family is preserved, an empty map removes all tags in that family, and a non-empty map replaces the complete tag family.
type UpdateCcdCommitmentDetails struct {
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateCcdCommitmentDetails) String() string
func (m UpdateCcdCommitmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateCcdCommitmentRequest wrapper for the UpdateCcdCommitment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ccdoffers/UpdateCcdCommitment.go.html to see an example of how to use UpdateCcdCommitmentRequest.
type UpdateCcdCommitmentRequest struct {
// CCD commitment OCID.
CcdCommitmentId *string `mandatory:"true" contributesTo:"path" name:"ccdCommitmentId"`
// The tag update details.
UpdateCcdCommitmentDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// is updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateCcdCommitmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCcdCommitmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCcdCommitmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCcdCommitmentRequest) String() string
func (request UpdateCcdCommitmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateCcdCommitmentResponse wrapper for the UpdateCcdCommitment operation
type UpdateCcdCommitmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The CcdCommitment instance
CcdCommitment `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateCcdCommitmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCcdCommitmentResponse) String() string
UsageEligibility The CCD commitment applicability restrictions. If the CCD offer has been created with any region- or AD-specific offer restriction, then it will be honored first over the usage eligibility criteria.
type UsageEligibility struct {
// The compartment OCID the CCD commitment is applicable to.
CompartmentIds []string `mandatory:"false" json:"compartmentIds"`
// The region the CCD commitment is applicable to.
// If the CCD offer has already been restricted to any specific region, then the offer will supersede this input.
Region *string `mandatory:"false" json:"region"`
// The Availability Domain the CCD is applicable to.
// If you're setting the `availabilityDomain`, ensure to also set the `region` property value.
// If the CCD offer has already been restricted to a specific Availability Domain, then the offer will supersede this input.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The tenancy IDs the CCD commitment is applicable to.
TenancyIds []string `mandatory:"false" json:"tenancyIds"`
}
func (m UsageEligibility) String() string
func (m UsageEligibility) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly