func GetAdminProductLifecycleStateEnumStringValues() []string
GetAdminProductLifecycleStateEnumStringValues Enumerates the set of values in String for AdminProductLifecycleStateEnum
func GetAdminProductSummaryLifecycleStateEnumStringValues() []string
GetAdminProductSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for AdminProductSummaryLifecycleStateEnum
func GetCreateProductDetailsBackfillEligibilityEnumStringValues() []string
GetCreateProductDetailsBackfillEligibilityEnumStringValues Enumerates the set of values in String for CreateProductDetailsBackfillEligibilityEnum
func GetProductLifecycleStateEnumStringValues() []string
GetProductLifecycleStateEnumStringValues Enumerates the set of values in String for ProductLifecycleStateEnum
func GetProductSummaryLifecycleStateEnumStringValues() []string
GetProductSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for ProductSummaryLifecycleStateEnum
func GetUpdateProductDetailsStateEnumStringValues() []string
GetUpdateProductDetailsStateEnumStringValues Enumerates the set of values in String for UpdateProductDetailsStateEnum
ActivateProductRequest wrapper for the ActivateProduct operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ActivateProduct.go.html to see an example of how to use ActivateProductRequest.
type ActivateProductRequest struct {
// OCID of the product
ProductId *string `mandatory:"true" contributesTo:"path" name:"productId"`
// 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"`
// 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"`
// 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 ActivateProductRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ActivateProductRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ActivateProductRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ActivateProductRequest) String() string
func (request ActivateProductRequest) 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
ActivateProductResponse wrapper for the ActivateProduct operation
type ActivateProductResponse struct {
// The underlying http response
RawResponse *http.Response
// The Product instance
Product `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 ActivateProductResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ActivateProductResponse) String() string
AdminProduct The properties of a product
type AdminProduct struct {
// OCID of the product
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment (remember that the tenancy is simply the root compartment).
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Name of the product, defined by service teams. Unique within one service
Name *string `mandatory:"true" json:"name"`
// description to the product
Description *string `mandatory:"true" json:"description"`
// List of meters associated with this product, including SKU information
MeterwithSKUs []MeterWithSku `mandatory:"true" json:"meterwithSKUs"`
// Name of the metering service this product relates to.
ServiceName *string `mandatory:"true" json:"serviceName"`
// List of limits that this product is associated with.
Limits []Limit `mandatory:"true" json:"limits"`
// The status of a product following the OCI standard. ACTIVE: resources of this product can be used by the end customer. INACTIVE: resources of this product can't be used by the end customer. Product needs manual approval. NEEDS_ATTENTION: operator action is needed.
LifecycleState AdminProductLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The displayed status of a product. lifecycleState to lifecycleDetails mapping: INACTIVE -> "Not yet launched" ACTIVE -> "Launched" NEEDS_ATTENTION -> "Pricing not set"
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Date and time when the product was created
// Example: `2022-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date and time when the product was updated. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Date and time when the product was set to ready. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeReady *common.SDKTime `mandatory:"false" json:"timeReady"`
// Date and time when the product was launched. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeLaunched *common.SDKTime `mandatory:"false" json:"timeLaunched"`
// Whether the product is currently excluded from SKU processing flows. Nullable when the
// exclusion flag has not been explicitly set.
IsExcluded *bool `mandatory:"false" json:"isExcluded"`
// Date and time when the product was marked as excluded. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeExcluded *common.SDKTime `mandatory:"false" json:"timeExcluded"`
// 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"`
}
func (m AdminProduct) String() string
func (m AdminProduct) 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
AdminProductLifecycleStateEnum Enum with underlying type: string
type AdminProductLifecycleStateEnum string
Set of constants representing the allowable values for AdminProductLifecycleStateEnum
const (
AdminProductLifecycleStateActive AdminProductLifecycleStateEnum = "ACTIVE"
AdminProductLifecycleStateInactive AdminProductLifecycleStateEnum = "INACTIVE"
AdminProductLifecycleStateNeedsAttention AdminProductLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetAdminProductLifecycleStateEnumValues() []AdminProductLifecycleStateEnum
GetAdminProductLifecycleStateEnumValues Enumerates the set of values for AdminProductLifecycleStateEnum
func GetMappingAdminProductLifecycleStateEnum(val string) (AdminProductLifecycleStateEnum, bool)
GetMappingAdminProductLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AdminProductSummary The properties of a product returned by the admin get API
type AdminProductSummary struct {
// OCID of the product
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment (remember that the tenancy is simply the root compartment).
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Name of the product, defined by service teams. Unique within one service
Name *string `mandatory:"true" json:"name"`
// description to the product
Description *string `mandatory:"true" json:"description"`
// List of meters associated with this product, including SKU information
MeterwithSKUs []MeterWithSku `mandatory:"true" json:"meterwithSKUs"`
// Name of the metering service this product relates to.
ServiceName *string `mandatory:"true" json:"serviceName"`
// List of limits that this product is associated with.
Limits []Limit `mandatory:"true" json:"limits"`
// The status of a product following the OCI standard. ACTIVE: resources of this product can be used by the end customer. INACTIVE: resources of this product can't be used by the end customer. Product needs manual approval. NEEDS_ATTENTION: operator action is needed.
LifecycleState AdminProductSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The displayed status of a product. lifecycleState to lifecycleDetails mapping: INACTIVE -> "Not yet launched" ACTIVE -> "Launched" NEEDS_ATTENTION -> "Pricing not set"
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Date and time when the product was created
// Example: `2022-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date and time when the product was updated. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Date and time when the product was set to ready. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeReady *common.SDKTime `mandatory:"false" json:"timeReady"`
// Date and time when the product was launched. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeLaunched *common.SDKTime `mandatory:"false" json:"timeLaunched"`
// Whether the product is currently excluded from SKU processing flows. Nullable when the
// exclusion flag has not been explicitly set.
IsExcluded *bool `mandatory:"false" json:"isExcluded"`
// Date and time when the product was marked as excluded. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeExcluded *common.SDKTime `mandatory:"false" json:"timeExcluded"`
// 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"`
}
func (m AdminProductSummary) String() string
func (m AdminProductSummary) 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
AdminProductSummaryLifecycleStateEnum Enum with underlying type: string
type AdminProductSummaryLifecycleStateEnum string
Set of constants representing the allowable values for AdminProductSummaryLifecycleStateEnum
const (
AdminProductSummaryLifecycleStateActive AdminProductSummaryLifecycleStateEnum = "ACTIVE"
AdminProductSummaryLifecycleStateInactive AdminProductSummaryLifecycleStateEnum = "INACTIVE"
AdminProductSummaryLifecycleStateNeedsAttention AdminProductSummaryLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetAdminProductSummaryLifecycleStateEnumValues() []AdminProductSummaryLifecycleStateEnum
GetAdminProductSummaryLifecycleStateEnumValues Enumerates the set of values for AdminProductSummaryLifecycleStateEnum
func GetMappingAdminProductSummaryLifecycleStateEnum(val string) (AdminProductSummaryLifecycleStateEnum, bool)
GetMappingAdminProductSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeAdminProductCompartmentRequest wrapper for the ChangeAdminProductCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ChangeAdminProductCompartment.go.html to see an example of how to use ChangeAdminProductCompartmentRequest.
type ChangeAdminProductCompartmentRequest struct {
// OCID of the product
ProductId *string `mandatory:"true" contributesTo:"path" name:"productId"`
// The payload for moving a product to a different compartment.
ChangeProductCompartmentDetails `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"`
// 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"`
// 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 ChangeAdminProductCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeAdminProductCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeAdminProductCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeAdminProductCompartmentRequest) String() string
func (request ChangeAdminProductCompartmentRequest) 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
ChangeAdminProductCompartmentResponse wrapper for the ChangeAdminProductCompartment operation
type ChangeAdminProductCompartmentResponse 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 ChangeAdminProductCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeAdminProductCompartmentResponse) String() string
ChangeInternalProductCompartmentRequest wrapper for the ChangeInternalProductCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ChangeInternalProductCompartment.go.html to see an example of how to use ChangeInternalProductCompartmentRequest.
type ChangeInternalProductCompartmentRequest struct {
// OCID of the product
ProductId *string `mandatory:"true" contributesTo:"path" name:"productId"`
// The payload for moving a product to a different compartment.
ChangeProductCompartmentDetails `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"`
// 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"`
// 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 ChangeInternalProductCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeInternalProductCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeInternalProductCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeInternalProductCompartmentRequest) String() string
func (request ChangeInternalProductCompartmentRequest) 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
ChangeInternalProductCompartmentResponse wrapper for the ChangeInternalProductCompartment operation
type ChangeInternalProductCompartmentResponse 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 ChangeInternalProductCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeInternalProductCompartmentResponse) String() string
ChangeProductCompartmentDetails The details to change the product's compartment.
type ChangeProductCompartmentDetails struct {
// The new product compartment OCID.
NewCompartmentId *string `mandatory:"true" json:"newCompartmentId"`
}
func (m ChangeProductCompartmentDetails) String() string
func (m ChangeProductCompartmentDetails) 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
CreateAdminProductRequest wrapper for the CreateAdminProduct operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/CreateAdminProduct.go.html to see an example of how to use CreateAdminProductRequest.
type CreateAdminProductRequest struct {
// The payload used to create a product
CreateProductDetails `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 CreateAdminProductRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAdminProductRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAdminProductRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAdminProductRequest) String() string
func (request CreateAdminProductRequest) 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
CreateAdminProductResponse wrapper for the CreateAdminProduct operation
type CreateAdminProductResponse struct {
// The underlying http response
RawResponse *http.Response
// The Product instance
Product `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 CreateAdminProductResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAdminProductResponse) String() string
CreateInternalProductRequest wrapper for the CreateInternalProduct operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/CreateInternalProduct.go.html to see an example of how to use CreateInternalProductRequest.
type CreateInternalProductRequest struct {
// The payload used to create a product
CreateProductDetails `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 CreateInternalProductRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateInternalProductRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateInternalProductRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateInternalProductRequest) String() string
func (request CreateInternalProductRequest) 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
CreateInternalProductResponse wrapper for the CreateInternalProduct operation
type CreateInternalProductResponse struct {
// The underlying http response
RawResponse *http.Response
// The Product instance
Product `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 CreateInternalProductResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateInternalProductResponse) String() string
CreateProductDetails The properties of a product
type CreateProductDetails struct {
// The OCID of the compartment (remember that the tenancy is simply the root compartment).
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Name of the product, defined by service teams. Unique within one service
Name *string `mandatory:"true" json:"name"`
// description to the product
Description *string `mandatory:"true" json:"description"`
// Name of the metering service this product relates to.
ServiceName *string `mandatory:"true" json:"serviceName"`
// List of meters associated with this product
Meters []Meter `mandatory:"false" json:"meters"`
// List of limits that this product is associated with.
Limits []Limit `mandatory:"false" json:"limits"`
// Optional create-time signal that marks the product as eligible for the backfill flow in
// existing Alloy regions. Omit this field to preserve the current create behavior. Final
// runtime backfill and auto-enable decisions remain worker-side.
BackfillEligibility CreateProductDetailsBackfillEligibilityEnum `mandatory:"false" json:"backfillEligibility,omitempty"`
// Optional create-time exclusion flag. When true, the product is created in an excluded
// state. Omit this field to preserve backward-compatible create behavior.
IsExcluded *bool `mandatory:"false" json:"isExcluded"`
}
func (m CreateProductDetails) String() string
func (m CreateProductDetails) 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
CreateProductDetailsBackfillEligibilityEnum Enum with underlying type: string
type CreateProductDetailsBackfillEligibilityEnum string
Set of constants representing the allowable values for CreateProductDetailsBackfillEligibilityEnum
const (
CreateProductDetailsBackfillEligibilityBackfillEligible CreateProductDetailsBackfillEligibilityEnum = "BACKFILL_ELIGIBLE"
)
func GetCreateProductDetailsBackfillEligibilityEnumValues() []CreateProductDetailsBackfillEligibilityEnum
GetCreateProductDetailsBackfillEligibilityEnumValues Enumerates the set of values for CreateProductDetailsBackfillEligibilityEnum
func GetMappingCreateProductDetailsBackfillEligibilityEnum(val string) (CreateProductDetailsBackfillEligibilityEnum, bool)
GetMappingCreateProductDetailsBackfillEligibilityEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteAdminProductRequest wrapper for the DeleteAdminProduct operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/DeleteAdminProduct.go.html to see an example of how to use DeleteAdminProductRequest.
type DeleteAdminProductRequest struct {
// OCID of the product
ProductId *string `mandatory:"true" contributesTo:"path" name:"productId"`
// 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 DeleteAdminProductRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAdminProductRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAdminProductRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAdminProductRequest) String() string
func (request DeleteAdminProductRequest) 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
DeleteAdminProductResponse wrapper for the DeleteAdminProduct operation
type DeleteAdminProductResponse 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 DeleteAdminProductResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAdminProductResponse) String() string
DeleteInternalProductRequest wrapper for the DeleteInternalProduct operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/DeleteInternalProduct.go.html to see an example of how to use DeleteInternalProductRequest.
type DeleteInternalProductRequest struct {
// OCID of the product
ProductId *string `mandatory:"true" contributesTo:"path" name:"productId"`
// 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 DeleteInternalProductRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteInternalProductRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteInternalProductRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteInternalProductRequest) String() string
func (request DeleteInternalProductRequest) 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
DeleteInternalProductResponse wrapper for the DeleteInternalProduct operation
type DeleteInternalProductResponse 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 DeleteInternalProductResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteInternalProductResponse) String() string
GetAdminProductRequest wrapper for the GetAdminProduct operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/GetAdminProduct.go.html to see an example of how to use GetAdminProductRequest.
type GetAdminProductRequest struct {
// OCID of the product
ProductId *string `mandatory:"true" contributesTo:"path" name:"productId"`
// 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 GetAdminProductRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAdminProductRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAdminProductRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAdminProductRequest) String() string
func (request GetAdminProductRequest) 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
GetAdminProductResponse wrapper for the GetAdminProduct operation
type GetAdminProductResponse struct {
// The underlying http response
RawResponse *http.Response
// The AdminProduct instance
AdminProduct `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 GetAdminProductResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAdminProductResponse) String() string
GetInternalProductRequest wrapper for the GetInternalProduct operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/GetInternalProduct.go.html to see an example of how to use GetInternalProductRequest.
type GetInternalProductRequest struct {
// OCID of the product
ProductId *string `mandatory:"true" contributesTo:"path" name:"productId"`
// 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 GetInternalProductRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetInternalProductRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetInternalProductRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetInternalProductRequest) String() string
func (request GetInternalProductRequest) 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
GetInternalProductResponse wrapper for the GetInternalProduct operation
type GetInternalProductResponse struct {
// The underlying http response
RawResponse *http.Response
// The Product instance
Product `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 GetInternalProductResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetInternalProductResponse) String() string
GetProductRequest wrapper for the GetProduct operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/GetProduct.go.html to see an example of how to use GetProductRequest.
type GetProductRequest struct {
// OCID of the product
ProductId *string `mandatory:"true" contributesTo:"path" name:"productId"`
// 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 GetProductRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetProductRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetProductRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetProductRequest) String() string
func (request GetProductRequest) 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
GetProductResponse wrapper for the GetProduct operation
type GetProductResponse struct {
// The underlying http response
RawResponse *http.Response
// The Product instance
Product `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 GetProductResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetProductResponse) String() string
Limit Limit that the use of a resource is controlled with
type Limit struct {
// public name of the limit
PublicLimitName *string `mandatory:"false" json:"publicLimitName"`
// public name of the limit service
PublicServiceName *string `mandatory:"false" json:"publicServiceName"`
}
func (m Limit) String() string
func (m Limit) 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
ListAdminProductsRequest wrapper for the ListAdminProducts operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ListAdminProducts.go.html to see an example of how to use ListAdminProductsRequest.
type ListAdminProductsRequest struct {
// 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 name of the product to be queried
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The OCID of the product to be queried
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The OCID of the compartment (remember that the tenancy is simply the root compartment).
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// 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 ListAdminProductsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAdminProductsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAdminProductsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAdminProductsRequest) String() string
func (request ListAdminProductsRequest) 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
ListAdminProductsResponse wrapper for the ListAdminProducts operation
type ListAdminProductsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ProductCollection instances
ProductCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListAdminProductsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAdminProductsResponse) String() string
ListInternalProductsRequest wrapper for the ListInternalProducts operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ListInternalProducts.go.html to see an example of how to use ListInternalProductsRequest.
type ListInternalProductsRequest struct {
// 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 name of the product to be queried
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The OCID of the product to be queried
Id *string `mandatory:"false" contributesTo:"query" name:"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 ListInternalProductsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListInternalProductsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListInternalProductsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListInternalProductsRequest) String() string
func (request ListInternalProductsRequest) 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
ListInternalProductsResponse wrapper for the ListInternalProducts operation
type ListInternalProductsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ProductCollection instances
ProductCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListInternalProductsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListInternalProductsResponse) String() string
ListProductsRequest wrapper for the ListProducts operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ListProducts.go.html to see an example of how to use ListProductsRequest.
type ListProductsRequest struct {
// 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 bPartNumber of the SKU to be used to filter the result. All the product has this sku in the skus list will be returned
SkusContains *string `mandatory:"false" contributesTo:"query" name:"skusContains"`
// The name of the product to be queried
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The lifecycleState used to filter the result
LifecycleState *string `mandatory:"false" contributesTo:"query" name:"lifecycleState"`
// A filter to return only the products with `timeReady` field greater than or equal to given value.
// Example: `2022-01-25T21:10:29.600Z`
TimeReadyGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeReadyGreaterThanOrEqualTo"`
// 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 OCID of the product to be queried
Id *string `mandatory:"false" contributesTo:"query" name:"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 ListProductsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListProductsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListProductsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProductsRequest) String() string
func (request ListProductsRequest) 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
ListProductsResponse wrapper for the ListProducts operation
type ListProductsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ProductCollection instances
ProductCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListProductsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListProductsResponse) String() string
Meter Meter defined in metering service
type Meter struct {
// Name of the meter
Name *string `mandatory:"false" json:"name"`
}
func (m Meter) String() string
func (m Meter) 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
MeterWithSku Meter defined in metering service with the associated SKU
type MeterWithSku struct {
// Name of the meter
Name *string `mandatory:"false" json:"name"`
// B number of the SKU associated with the meter
SkuBNumber *string `mandatory:"false" json:"skuBNumber"`
// Description of the SKU associated with the meter
SkuDescription *string `mandatory:"false" json:"skuDescription"`
}
func (m MeterWithSku) String() string
func (m MeterWithSku) 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
Product The fields of a product to be displayed to the operator in OCI Console
type Product struct {
// OCID of the product
Id *string `mandatory:"true" json:"id"`
// Name of the product, defined by service teams. Unique within one service
Name *string `mandatory:"true" json:"name"`
// List of skus associated with this product.
Skus []SkuSummary `mandatory:"true" json:"skus"`
// Name of the metering service this product relates to.
ServiceName *string `mandatory:"true" json:"serviceName"`
// The status of a product following the OCI standard. ACTIVE: resources of this product can be used by the end customer. INACTIVE: resources of this product can't be used by the end customer. Product needs manual approval. NEEDS_ATTENTION: operator action is needed.
LifecycleState ProductLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// description to the product
Description *string `mandatory:"true" json:"description"`
// The displayed status of a product. lifecycleState to lifecycleDetails mapping: INACTIVE -> "Not yet launched" ACTIVE -> "Launched" NEEDS_ATTENTION -> "Pricing not set"
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Date and time when the product is created
// Example: `2022-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date and time when the product is launched. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeLaunched *common.SDKTime `mandatory:"false" json:"timeLaunched"`
// Date and time when the product is ready to be launched. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeReady *common.SDKTime `mandatory:"false" json:"timeReady"`
// Indicates whether the product is currently excluded from SKU processing flows. This
// field is nullable when the exclusion flag has not been explicitly set.
IsExcluded *bool `mandatory:"false" json:"isExcluded"`
// 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"`
}
func (m Product) String() string
func (m Product) 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
ProductAdminClient a client for ProductAdmin
type ProductAdminClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewProductAdminClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ProductAdminClient, err error)
NewProductAdminClientWithConfigurationProvider Creates a new default ProductAdmin client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewProductAdminClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ProductAdminClient, err error)
NewProductAdminClientWithOboToken Creates a new default ProductAdmin 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 ProductAdminClient) ChangeAdminProductCompartment(ctx context.Context, request ChangeAdminProductCompartmentRequest) (response ChangeAdminProductCompartmentResponse, err error)
ChangeAdminProductCompartment Change product compartment
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ChangeAdminProductCompartment.go.html to see an example of how to use ChangeAdminProductCompartment API. A default retry strategy applies to this operation ChangeAdminProductCompartment()
func (client *ProductAdminClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ProductAdminClient) CreateAdminProduct(ctx context.Context, request CreateAdminProductRequest) (response CreateAdminProductResponse, err error)
CreateAdminProduct Used by the OCI service teams to create a product to control the availability of the relative resources
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/CreateAdminProduct.go.html to see an example of how to use CreateAdminProduct API. A default retry strategy applies to this operation CreateAdminProduct()
func (client ProductAdminClient) DeleteAdminProduct(ctx context.Context, request DeleteAdminProductRequest) (response DeleteAdminProductResponse, err error)
DeleteAdminProduct Delete the product
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/DeleteAdminProduct.go.html to see an example of how to use DeleteAdminProduct API. A default retry strategy applies to this operation DeleteAdminProduct()
func (client ProductAdminClient) GetAdminProduct(ctx context.Context, request GetAdminProductRequest) (response GetAdminProductResponse, err error)
GetAdminProduct Get the product by ID
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/GetAdminProduct.go.html to see an example of how to use GetAdminProduct API. A default retry strategy applies to this operation GetAdminProduct()
func (client ProductAdminClient) ListAdminProducts(ctx context.Context, request ListAdminProductsRequest) (response ListAdminProductsResponse, err error)
ListAdminProducts List the products with the filters
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ListAdminProducts.go.html to see an example of how to use ListAdminProducts API. A default retry strategy applies to this operation ListAdminProducts()
func (client *ProductAdminClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ProductAdminClient) UpdateAdminProduct(ctx context.Context, request UpdateAdminProductRequest) (response UpdateAdminProductResponse, err error)
UpdateAdminProduct Update the product
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/UpdateAdminProduct.go.html to see an example of how to use UpdateAdminProduct API. A default retry strategy applies to this operation UpdateAdminProduct()
ProductClient a client for Product
type ProductClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewProductClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ProductClient, err error)
NewProductClientWithConfigurationProvider Creates a new default Product client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewProductClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ProductClient, err error)
NewProductClientWithOboToken Creates a new default Product 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 ProductClient) ActivateProduct(ctx context.Context, request ActivateProductRequest) (response ActivateProductResponse, err error)
ActivateProduct Activate the target Product. Change lifecycleState from INACTIVE to ACTIVE.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ActivateProduct.go.html to see an example of how to use ActivateProduct API. A default retry strategy applies to this operation ActivateProduct()
func (client *ProductClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ProductClient) GetProduct(ctx context.Context, request GetProductRequest) (response GetProductResponse, err error)
GetProduct Get product by ID
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/GetProduct.go.html to see an example of how to use GetProduct API. A default retry strategy applies to this operation GetProduct()
func (client ProductClient) ListProducts(ctx context.Context, request ListProductsRequest) (response ListProductsResponse, err error)
ListProducts List products
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ListProducts.go.html to see an example of how to use ListProducts API. A default retry strategy applies to this operation ListProducts()
func (client *ProductClient) SetRegion(region string)
SetRegion overrides the region of this client.
ProductCollection List of Products
type ProductCollection struct {
// List of Products
Items []ProductSummary `mandatory:"true" json:"items"`
}
func (m ProductCollection) String() string
func (m ProductCollection) 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
ProductInternalClient a client for ProductInternal
type ProductInternalClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewProductInternalClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ProductInternalClient, err error)
NewProductInternalClientWithConfigurationProvider Creates a new default ProductInternal client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewProductInternalClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ProductInternalClient, err error)
NewProductInternalClientWithOboToken Creates a new default ProductInternal 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 ProductInternalClient) ChangeInternalProductCompartment(ctx context.Context, request ChangeInternalProductCompartmentRequest) (response ChangeInternalProductCompartmentResponse, err error)
ChangeInternalProductCompartment Change product compartment
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ChangeInternalProductCompartment.go.html to see an example of how to use ChangeInternalProductCompartment API. A default retry strategy applies to this operation ChangeInternalProductCompartment()
func (client *ProductInternalClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ProductInternalClient) CreateInternalProduct(ctx context.Context, request CreateInternalProductRequest) (response CreateInternalProductResponse, err error)
CreateInternalProduct Used by the OCI service teams to create a product to control the availability of the relative resources
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/CreateInternalProduct.go.html to see an example of how to use CreateInternalProduct API. A default retry strategy applies to this operation CreateInternalProduct()
func (client ProductInternalClient) DeleteInternalProduct(ctx context.Context, request DeleteInternalProductRequest) (response DeleteInternalProductResponse, err error)
DeleteInternalProduct Delete the product
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/DeleteInternalProduct.go.html to see an example of how to use DeleteInternalProduct API. A default retry strategy applies to this operation DeleteInternalProduct()
func (client ProductInternalClient) GetInternalProduct(ctx context.Context, request GetInternalProductRequest) (response GetInternalProductResponse, err error)
GetInternalProduct Get the product by ID
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/GetInternalProduct.go.html to see an example of how to use GetInternalProduct API. A default retry strategy applies to this operation GetInternalProduct()
func (client ProductInternalClient) ListInternalProducts(ctx context.Context, request ListInternalProductsRequest) (response ListInternalProductsResponse, err error)
ListInternalProducts List the products with the filters
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/ListInternalProducts.go.html to see an example of how to use ListInternalProducts API. A default retry strategy applies to this operation ListInternalProducts()
func (client *ProductInternalClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ProductInternalClient) UpdateInternalProduct(ctx context.Context, request UpdateInternalProductRequest) (response UpdateInternalProductResponse, err error)
UpdateInternalProduct Update the product
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/UpdateInternalProduct.go.html to see an example of how to use UpdateInternalProduct API. A default retry strategy applies to this operation UpdateInternalProduct()
ProductLifecycleStateEnum Enum with underlying type: string
type ProductLifecycleStateEnum string
Set of constants representing the allowable values for ProductLifecycleStateEnum
const (
ProductLifecycleStateActive ProductLifecycleStateEnum = "ACTIVE"
ProductLifecycleStateInactive ProductLifecycleStateEnum = "INACTIVE"
ProductLifecycleStateNeedsAttention ProductLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetMappingProductLifecycleStateEnum(val string) (ProductLifecycleStateEnum, bool)
GetMappingProductLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProductLifecycleStateEnumValues() []ProductLifecycleStateEnum
GetProductLifecycleStateEnumValues Enumerates the set of values for ProductLifecycleStateEnum
ProductSummary The fields of a product to be displayed to the operator in OCI Console
type ProductSummary struct {
// OCID of the product
Id *string `mandatory:"true" json:"id"`
// Name of the product, defined by service teams. Unique within one service
Name *string `mandatory:"true" json:"name"`
// List of skus associated with this product.
Skus []SkuSummary `mandatory:"true" json:"skus"`
// Name of the metering service this product relates to.
ServiceName *string `mandatory:"true" json:"serviceName"`
// The status of a product following the OCI standard. ACTIVE: resources of this product can be used by the end customer. INACTIVE: resources of this product can't be used by the end customer. Product needs manual approval. NEEDS_ATTENTION: operator action is needed.
LifecycleState ProductSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The displayed status of a product. lifecycleState to lifecycleDetails mapping: INACTIVE -> "Not yet launched" ACTIVE -> "Launched" NEEDS_ATTENTION -> "Pricing not set"
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Date and time when the product is created
// Example: `2022-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date and time when the product is launched. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeLaunched *common.SDKTime `mandatory:"false" json:"timeLaunched"`
// Date and time when the product is ready to be launched. Nullable
// Example: `2022-01-25T21:10:29.600Z`
TimeReady *common.SDKTime `mandatory:"false" json:"timeReady"`
// Indicates whether the product is currently excluded from SKU processing flows. This
// field is nullable when the exclusion flag has not been explicitly set.
IsExcluded *bool `mandatory:"false" json:"isExcluded"`
// 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"`
}
func (m ProductSummary) String() string
func (m ProductSummary) 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
ProductSummaryLifecycleStateEnum Enum with underlying type: string
type ProductSummaryLifecycleStateEnum string
Set of constants representing the allowable values for ProductSummaryLifecycleStateEnum
const (
ProductSummaryLifecycleStateActive ProductSummaryLifecycleStateEnum = "ACTIVE"
ProductSummaryLifecycleStateInactive ProductSummaryLifecycleStateEnum = "INACTIVE"
ProductSummaryLifecycleStateNeedsAttention ProductSummaryLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetMappingProductSummaryLifecycleStateEnum(val string) (ProductSummaryLifecycleStateEnum, bool)
GetMappingProductSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProductSummaryLifecycleStateEnumValues() []ProductSummaryLifecycleStateEnum
GetProductSummaryLifecycleStateEnumValues Enumerates the set of values for ProductSummaryLifecycleStateEnum
SkuSummary The details of a sku
type SkuSummary struct {
// sku bpartNumber
BpartNumber *string `mandatory:"true" json:"bpartNumber"`
// description of the sku
Description *string `mandatory:"false" json:"description"`
}
func (m SkuSummary) String() string
func (m SkuSummary) 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
UpdateAdminProductRequest wrapper for the UpdateAdminProduct operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/UpdateAdminProduct.go.html to see an example of how to use UpdateAdminProductRequest.
type UpdateAdminProductRequest struct {
// OCID of the product
ProductId *string `mandatory:"true" contributesTo:"path" name:"productId"`
// The payload used to update the product.
UpdateProductDetails `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 UpdateAdminProductRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAdminProductRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAdminProductRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAdminProductRequest) String() string
func (request UpdateAdminProductRequest) 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
UpdateAdminProductResponse wrapper for the UpdateAdminProduct operation
type UpdateAdminProductResponse struct {
// The underlying http response
RawResponse *http.Response
// The Product instance
Product `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 UpdateAdminProductResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAdminProductResponse) String() string
UpdateInternalProductRequest wrapper for the UpdateInternalProduct operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ociproductcatalog/UpdateInternalProduct.go.html to see an example of how to use UpdateInternalProductRequest.
type UpdateInternalProductRequest struct {
// OCID of the product
ProductId *string `mandatory:"true" contributesTo:"path" name:"productId"`
// The payload used to update the product.
UpdateProductDetails `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 UpdateInternalProductRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateInternalProductRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateInternalProductRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateInternalProductRequest) String() string
func (request UpdateInternalProductRequest) 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
UpdateInternalProductResponse wrapper for the UpdateInternalProduct operation
type UpdateInternalProductResponse struct {
// The underlying http response
RawResponse *http.Response
// The Product instance
Product `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 UpdateInternalProductResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateInternalProductResponse) String() string
UpdateProductDetails The properties of a product
type UpdateProductDetails struct {
// Name of the product, defined by service teams. Unique within one service
Name *string `mandatory:"false" json:"name"`
// description to the product
Description *string `mandatory:"false" json:"description"`
// The current state of the product. READY - The product is fully configured and ready for activation. ENABLED - The product is active. DISABLED - The product is inactive and not ready for activation. DELETED - The product has been deleted. NEEDS_ATTENTION - Pricing not set.
State UpdateProductDetailsStateEnum `mandatory:"false" json:"state,omitempty"`
// List of meters associated with this product
Meters []Meter `mandatory:"false" json:"meters"`
// Name of the metering service this product relates to.
ServiceName *string `mandatory:"false" json:"serviceName"`
// List of limits that this product is associated with.
Limits []Limit `mandatory:"false" json:"limits"`
// Optional exclusion flag update. When true, marks the product as excluded. When false,
// clears the exclusion state.
IsExcluded *bool `mandatory:"false" json:"isExcluded"`
}
func (m UpdateProductDetails) String() string
func (m UpdateProductDetails) 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
UpdateProductDetailsStateEnum Enum with underlying type: string
type UpdateProductDetailsStateEnum string
Set of constants representing the allowable values for UpdateProductDetailsStateEnum
const (
UpdateProductDetailsStateReady UpdateProductDetailsStateEnum = "READY"
UpdateProductDetailsStateEnabled UpdateProductDetailsStateEnum = "ENABLED"
UpdateProductDetailsStateDisabled UpdateProductDetailsStateEnum = "DISABLED"
UpdateProductDetailsStateDeleted UpdateProductDetailsStateEnum = "DELETED"
UpdateProductDetailsStateNeedsAttention UpdateProductDetailsStateEnum = "NEEDS_ATTENTION"
)
func GetMappingUpdateProductDetailsStateEnum(val string) (UpdateProductDetailsStateEnum, bool)
GetMappingUpdateProductDetailsStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateProductDetailsStateEnumValues() []UpdateProductDetailsStateEnum
GetUpdateProductDetailsStateEnumValues Enumerates the set of values for UpdateProductDetailsStateEnum