osubusage

package
v65.71.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 6, 2024 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetComputedUsageAggregatedSummaryPricingModelEnumStringValues

func GetComputedUsageAggregatedSummaryPricingModelEnumStringValues() []string

GetComputedUsageAggregatedSummaryPricingModelEnumStringValues Enumerates the set of values in String for ComputedUsageAggregatedSummaryPricingModelEnum

func GetComputedUsageAggregationTypeEnumStringValues

func GetComputedUsageAggregationTypeEnumStringValues() []string

GetComputedUsageAggregationTypeEnumStringValues Enumerates the set of values in String for ComputedUsageAggregationTypeEnum

func GetComputedUsageSummaryTypeEnumStringValues

func GetComputedUsageSummaryTypeEnumStringValues() []string

GetComputedUsageSummaryTypeEnumStringValues Enumerates the set of values in String for ComputedUsageSummaryTypeEnum

func GetComputedUsageTypeEnumStringValues

func GetComputedUsageTypeEnumStringValues() []string

GetComputedUsageTypeEnumStringValues Enumerates the set of values in String for ComputedUsageTypeEnum

func GetListComputedUsageAggregatedsGroupingEnumStringValues

func GetListComputedUsageAggregatedsGroupingEnumStringValues() []string

GetListComputedUsageAggregatedsGroupingEnumStringValues Enumerates the set of values in String for ListComputedUsageAggregatedsGroupingEnum

func GetListComputedUsagesSortByEnumStringValues

func GetListComputedUsagesSortByEnumStringValues() []string

GetListComputedUsagesSortByEnumStringValues Enumerates the set of values in String for ListComputedUsagesSortByEnum

func GetListComputedUsagesSortOrderEnumStringValues

func GetListComputedUsagesSortOrderEnumStringValues() []string

GetListComputedUsagesSortOrderEnumStringValues Enumerates the set of values in String for ListComputedUsagesSortOrderEnum

Types

type ComputedUsage

type ComputedUsage struct {

	// SPM Internal computed usage Id , 32 character string
	Id *string `mandatory:"true" json:"id"`

	// Computed Usage created time, expressed in RFC 3339 timestamp format.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Computed Usage updated time, expressed in RFC 3339 timestamp format.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// Subscribed service line parent id
	ParentSubscribedServiceId *string `mandatory:"false" json:"parentSubscribedServiceId"`

	ParentProduct *Product `mandatory:"false" json:"parentProduct"`

	// Subscription plan number
	PlanNumber *string `mandatory:"false" json:"planNumber"`

	// Currency code
	CurrencyCode *string `mandatory:"false" json:"currencyCode"`

	// References the tier in the ratecard for that usage (OCI will be using the same reference to cross-reference for correctness on the usage csv report), comes from Entity OBSCNTR_IPT_PRODUCTTIER.
	RateCardTierdId *string `mandatory:"false" json:"rateCardTierdId"`

	// Ratecard Id at subscribed service level
	RateCardId *string `mandatory:"false" json:"rateCardId"`

	// SPM Internal compute records source .
	ComputeSource *string `mandatory:"false" json:"computeSource"`

	// Data Center Attribute as sent by MQS to SPM.
	DataCenter *string `mandatory:"false" json:"dataCenter"`

	// MQS Identfier send to SPM , SPM does not transform this attribute and is received as is.
	MqsMessageId *string `mandatory:"false" json:"mqsMessageId"`

	// Total Quantity that was used for computation
	Quantity *string `mandatory:"false" json:"quantity"`

	// SPM Internal usage Line number identifier in SPM coming from Metered Services entity.
	UsageNumber *string `mandatory:"false" json:"usageNumber"`

	// SPM Internal Original usage Line number identifier in SPM coming from Metered Services entity.
	OriginalUsageNumber *string `mandatory:"false" json:"originalUsageNumber"`

	// Subscribed service commitmentId.
	CommitmentServiceId *string `mandatory:"false" json:"commitmentServiceId"`

	// Invoicing status for the aggregated compute usage
	IsInvoiced *bool `mandatory:"false" json:"isInvoiced"`

	// Usage compute type in SPM.
	Type ComputedUsageTypeEnum `mandatory:"false" json:"type,omitempty"`

	// Usae computation date, expressed in RFC 3339 timestamp format.
	TimeOfArrival *common.SDKTime `mandatory:"false" json:"timeOfArrival"`

	// Metered Service date, expressed in RFC 3339 timestamp format.
	TimeMeteredOn *common.SDKTime `mandatory:"false" json:"timeMeteredOn"`

	// Net Unit Price for the product in consideration, price actual.
	NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`

	// Computed Line Amount rounded.
	CostRounded *string `mandatory:"false" json:"costRounded"`

	// Computed Line Amount not rounded
	Cost *string `mandatory:"false" json:"cost"`

	Product *Product `mandatory:"false" json:"product"`

	// Unit of Messure
	UnitOfMeasure *string `mandatory:"false" json:"unitOfMeasure"`
}

ComputedUsage Computed Usage Summary object

func (ComputedUsage) String

func (m ComputedUsage) String() string

func (ComputedUsage) ValidateEnumValue

func (m ComputedUsage) 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

type ComputedUsageAggregatedSummary

type ComputedUsageAggregatedSummary struct {

	// Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM
	SubscriptionId *string `mandatory:"true" json:"subscriptionId"`

	// Subscribed service line parent id
	ParentSubscribedServiceId *string `mandatory:"false" json:"parentSubscribedServiceId"`

	ParentProduct *Product `mandatory:"false" json:"parentProduct"`

	// Subscribed services contract line start date, expressed in RFC 3339 timestamp format.
	TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`

	// Subscribed services contract line end date, expressed in RFC 3339 timestamp format.
	TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`

	// Subscribed service asociated subscription plan number.
	PlanNumber *string `mandatory:"false" json:"planNumber"`

	// Currency code
	CurrencyCode *string `mandatory:"false" json:"currencyCode"`

	// Inernal SPM Ratecard Id at line level
	RateCardId *string `mandatory:"false" json:"rateCardId"`

	// Subscribed services pricing model
	PricingModel ComputedUsageAggregatedSummaryPricingModelEnum `mandatory:"false" json:"pricingModel,omitempty"`

	// Aggregation of computed usages for the subscribed service.
	AggregatedComputedUsages []ComputedUsageAggregation `mandatory:"false" json:"aggregatedComputedUsages"`
}

ComputedUsageAggregatedSummary Subscribed Service Contract details

func (ComputedUsageAggregatedSummary) String

func (ComputedUsageAggregatedSummary) ValidateEnumValue

func (m ComputedUsageAggregatedSummary) 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

type ComputedUsageAggregatedSummaryPricingModelEnum

type ComputedUsageAggregatedSummaryPricingModelEnum string

ComputedUsageAggregatedSummaryPricingModelEnum Enum with underlying type: string

const (
	ComputedUsageAggregatedSummaryPricingModelPayAsYouGo       ComputedUsageAggregatedSummaryPricingModelEnum = "PAY_AS_YOU_GO"
	ComputedUsageAggregatedSummaryPricingModelMonthly          ComputedUsageAggregatedSummaryPricingModelEnum = "MONTHLY"
	ComputedUsageAggregatedSummaryPricingModelAnnual           ComputedUsageAggregatedSummaryPricingModelEnum = "ANNUAL"
	ComputedUsageAggregatedSummaryPricingModelPrepaid          ComputedUsageAggregatedSummaryPricingModelEnum = "PREPAID"
	ComputedUsageAggregatedSummaryPricingModelFundedAllocation ComputedUsageAggregatedSummaryPricingModelEnum = "FUNDED_ALLOCATION"
)

Set of constants representing the allowable values for ComputedUsageAggregatedSummaryPricingModelEnum

func GetComputedUsageAggregatedSummaryPricingModelEnumValues

func GetComputedUsageAggregatedSummaryPricingModelEnumValues() []ComputedUsageAggregatedSummaryPricingModelEnum

GetComputedUsageAggregatedSummaryPricingModelEnumValues Enumerates the set of values for ComputedUsageAggregatedSummaryPricingModelEnum

func GetMappingComputedUsageAggregatedSummaryPricingModelEnum

func GetMappingComputedUsageAggregatedSummaryPricingModelEnum(val string) (ComputedUsageAggregatedSummaryPricingModelEnum, bool)

GetMappingComputedUsageAggregatedSummaryPricingModelEnum performs case Insensitive comparison on enum value and return the desired enum

type ComputedUsageAggregation

type ComputedUsageAggregation struct {

	// Total Quantity that was used for computation
	Quantity *string `mandatory:"false" json:"quantity"`

	Product *Product `mandatory:"false" json:"product"`

	// Data Center Attribute as sent by MQS to SPM.
	DataCenter *string `mandatory:"false" json:"dataCenter"`

	// Metered Service date , expressed in RFC 3339 timestamp format.
	TimeMeteredOn *common.SDKTime `mandatory:"false" json:"timeMeteredOn"`

	// Net Unit Price for the product in consideration.
	NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`

	// Sum of Computed Line Amount unrounded
	CostUnrounded *string `mandatory:"false" json:"costUnrounded"`

	// Sum of Computed Line Amount rounded
	Cost *string `mandatory:"false" json:"cost"`

	// Usage compute type in SPM.
	Type ComputedUsageAggregationTypeEnum `mandatory:"false" json:"type,omitempty"`
}

ComputedUsageAggregation Computed Usage Aggregation object

func (ComputedUsageAggregation) String

func (m ComputedUsageAggregation) String() string

func (ComputedUsageAggregation) ValidateEnumValue

func (m ComputedUsageAggregation) 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

type ComputedUsageAggregationTypeEnum

type ComputedUsageAggregationTypeEnum string

ComputedUsageAggregationTypeEnum Enum with underlying type: string

const (
	ComputedUsageAggregationTypePromotion                     ComputedUsageAggregationTypeEnum = "PROMOTION"
	ComputedUsageAggregationTypeDoNotBill                     ComputedUsageAggregationTypeEnum = "DO_NOT_BILL"
	ComputedUsageAggregationTypeUsage                         ComputedUsageAggregationTypeEnum = "USAGE"
	ComputedUsageAggregationTypeCommit                        ComputedUsageAggregationTypeEnum = "COMMIT"
	ComputedUsageAggregationTypeOverage                       ComputedUsageAggregationTypeEnum = "OVERAGE"
	ComputedUsageAggregationTypePayAsYouGo                    ComputedUsageAggregationTypeEnum = "PAY_AS_YOU_GO"
	ComputedUsageAggregationTypeMonthlyMinimum                ComputedUsageAggregationTypeEnum = "MONTHLY_MINIMUM"
	ComputedUsageAggregationTypeDelayedUsageInvoiceTiming     ComputedUsageAggregationTypeEnum = "DELAYED_USAGE_INVOICE_TIMING"
	ComputedUsageAggregationTypeDelayedUsageCommitmentExp     ComputedUsageAggregationTypeEnum = "DELAYED_USAGE_COMMITMENT_EXP"
	ComputedUsageAggregationTypeOnAccountCredit               ComputedUsageAggregationTypeEnum = "ON_ACCOUNT_CREDIT"
	ComputedUsageAggregationTypeServiceCredit                 ComputedUsageAggregationTypeEnum = "SERVICE_CREDIT"
	ComputedUsageAggregationTypeCommitmentExpiration          ComputedUsageAggregationTypeEnum = "COMMITMENT_EXPIRATION"
	ComputedUsageAggregationTypeFundedAllocation              ComputedUsageAggregationTypeEnum = "FUNDED_ALLOCATION"
	ComputedUsageAggregationTypeDonotBillUsagePostTermination ComputedUsageAggregationTypeEnum = "DONOT_BILL_USAGE_POST_TERMINATION"
	ComputedUsageAggregationTypeDelayedUsagePostTermination   ComputedUsageAggregationTypeEnum = "DELAYED_USAGE_POST_TERMINATION"
)

Set of constants representing the allowable values for ComputedUsageAggregationTypeEnum

func GetComputedUsageAggregationTypeEnumValues

func GetComputedUsageAggregationTypeEnumValues() []ComputedUsageAggregationTypeEnum

GetComputedUsageAggregationTypeEnumValues Enumerates the set of values for ComputedUsageAggregationTypeEnum

func GetMappingComputedUsageAggregationTypeEnum

func GetMappingComputedUsageAggregationTypeEnum(val string) (ComputedUsageAggregationTypeEnum, bool)

GetMappingComputedUsageAggregationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ComputedUsageClient

type ComputedUsageClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

ComputedUsageClient a client for ComputedUsage

func NewComputedUsageClientWithConfigurationProvider

func NewComputedUsageClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ComputedUsageClient, err error)

NewComputedUsageClientWithConfigurationProvider Creates a new default ComputedUsage client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewComputedUsageClientWithOboToken

func NewComputedUsageClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ComputedUsageClient, err error)

NewComputedUsageClientWithOboToken Creates a new default ComputedUsage 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 (*ComputedUsageClient) ConfigurationProvider

func (client *ComputedUsageClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (ComputedUsageClient) GetComputedUsage

func (client ComputedUsageClient) GetComputedUsage(ctx context.Context, request GetComputedUsageRequest) (response GetComputedUsageResponse, err error)

GetComputedUsage This is an API which returns Computed Usage corresponding to the id passed

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/osubusage/GetComputedUsage.go.html to see an example of how to use GetComputedUsage API.

func (ComputedUsageClient) ListComputedUsageAggregateds

func (client ComputedUsageClient) ListComputedUsageAggregateds(ctx context.Context, request ListComputedUsageAggregatedsRequest) (response ListComputedUsageAggregatedsResponse, err error)

ListComputedUsageAggregateds This is a collection API which returns a list of aggregated computed usage details (there can be multiple Parent Products under a given SubID each of which is represented under Subscription Service Line # in SPM).

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/osubusage/ListComputedUsageAggregateds.go.html to see an example of how to use ListComputedUsageAggregateds API.

func (ComputedUsageClient) ListComputedUsages

func (client ComputedUsageClient) ListComputedUsages(ctx context.Context, request ListComputedUsagesRequest) (response ListComputedUsagesResponse, err error)

ListComputedUsages This is a collection API which returns a list of Computed Usages for given filters.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/osubusage/ListComputedUsages.go.html to see an example of how to use ListComputedUsages API.

func (*ComputedUsageClient) SetRegion

func (client *ComputedUsageClient) SetRegion(region string)

SetRegion overrides the region of this client.

type ComputedUsageSummary

type ComputedUsageSummary struct {

	// SPM Internal computed usage Id , 32 character string
	ComputedUsageId *string `mandatory:"true" json:"computedUsageId"`

	// Computed Usage created time, expressed in RFC 3339 timestamp format.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Computed Usage updated time, expressed in RFC 3339 timestamp format.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// Subscribed service line parent id
	ParentSubscribedServiceId *string `mandatory:"false" json:"parentSubscribedServiceId"`

	ParentProduct *Product `mandatory:"false" json:"parentProduct"`

	// Subscription plan number
	PlanNumber *string `mandatory:"false" json:"planNumber"`

	// Currency code
	CurrencyCode *string `mandatory:"false" json:"currencyCode"`

	// References the tier in the ratecard for that usage (OCI will be using the same reference to cross-reference for correctness on the usage csv report), comes from Entity OBSCNTR_IPT_PRODUCTTIER.
	RateCardTierdId *string `mandatory:"false" json:"rateCardTierdId"`

	// Ratecard Id at subscribed service level
	RateCardId *string `mandatory:"false" json:"rateCardId"`

	// SPM Internal compute records source .
	ComputeSource *string `mandatory:"false" json:"computeSource"`

	// Data Center Attribute as sent by MQS to SPM.
	DataCenter *string `mandatory:"false" json:"dataCenter"`

	// MQS Identfier send to SPM , SPM does not transform this attribute and is received as is.
	MqsMessageId *string `mandatory:"false" json:"mqsMessageId"`

	// Total Quantity that was used for computation
	Quantity *string `mandatory:"false" json:"quantity"`

	// SPM Internal usage Line number identifier in SPM coming from Metered Services entity.
	UsageNumber *string `mandatory:"false" json:"usageNumber"`

	// SPM Internal Original usage Line number identifier in SPM coming from Metered Services entity.
	OriginalUsageNumber *string `mandatory:"false" json:"originalUsageNumber"`

	// Subscribed service commitmentId.
	CommitmentServiceId *string `mandatory:"false" json:"commitmentServiceId"`

	// Invoicing status for the aggregated compute usage
	IsInvoiced *bool `mandatory:"false" json:"isInvoiced"`

	// Usage compute type in SPM.
	Type ComputedUsageSummaryTypeEnum `mandatory:"false" json:"type,omitempty"`

	// Usae computation date, expressed in RFC 3339 timestamp format.
	TimeOfArrival *common.SDKTime `mandatory:"false" json:"timeOfArrival"`

	// Metered Service date, expressed in RFC 3339 timestamp format.
	TimeMeteredOn *common.SDKTime `mandatory:"false" json:"timeMeteredOn"`

	// Net Unit Price for the product in consideration, price actual.
	NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`

	// Computed Line Amount rounded.
	CostRounded *string `mandatory:"false" json:"costRounded"`

	// Computed Line Amount not rounded
	Cost *string `mandatory:"false" json:"cost"`

	Product *Product `mandatory:"false" json:"product"`

	// Unit of Messure
	UnitOfMeasure *string `mandatory:"false" json:"unitOfMeasure"`
}

ComputedUsageSummary Computed Usage Summary object

func (ComputedUsageSummary) String

func (m ComputedUsageSummary) String() string

func (ComputedUsageSummary) ValidateEnumValue

func (m ComputedUsageSummary) 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

type ComputedUsageSummaryTypeEnum

type ComputedUsageSummaryTypeEnum string

ComputedUsageSummaryTypeEnum Enum with underlying type: string

const (
	ComputedUsageSummaryTypePromotion                     ComputedUsageSummaryTypeEnum = "PROMOTION"
	ComputedUsageSummaryTypeDoNotBill                     ComputedUsageSummaryTypeEnum = "DO_NOT_BILL"
	ComputedUsageSummaryTypeUsage                         ComputedUsageSummaryTypeEnum = "USAGE"
	ComputedUsageSummaryTypeCommit                        ComputedUsageSummaryTypeEnum = "COMMIT"
	ComputedUsageSummaryTypeOverage                       ComputedUsageSummaryTypeEnum = "OVERAGE"
	ComputedUsageSummaryTypePayAsYouGo                    ComputedUsageSummaryTypeEnum = "PAY_AS_YOU_GO"
	ComputedUsageSummaryTypeMonthlyMinimum                ComputedUsageSummaryTypeEnum = "MONTHLY_MINIMUM"
	ComputedUsageSummaryTypeDelayedUsageInvoiceTiming     ComputedUsageSummaryTypeEnum = "DELAYED_USAGE_INVOICE_TIMING"
	ComputedUsageSummaryTypeDelayedUsageCommitmentExp     ComputedUsageSummaryTypeEnum = "DELAYED_USAGE_COMMITMENT_EXP"
	ComputedUsageSummaryTypeOnAccountCredit               ComputedUsageSummaryTypeEnum = "ON_ACCOUNT_CREDIT"
	ComputedUsageSummaryTypeServiceCredit                 ComputedUsageSummaryTypeEnum = "SERVICE_CREDIT"
	ComputedUsageSummaryTypeCommitmentExpiration          ComputedUsageSummaryTypeEnum = "COMMITMENT_EXPIRATION"
	ComputedUsageSummaryTypeFundedAllocation              ComputedUsageSummaryTypeEnum = "FUNDED_ALLOCATION"
	ComputedUsageSummaryTypeDonotBillUsagePostTermination ComputedUsageSummaryTypeEnum = "DONOT_BILL_USAGE_POST_TERMINATION"
	ComputedUsageSummaryTypeDelayedUsagePostTermination   ComputedUsageSummaryTypeEnum = "DELAYED_USAGE_POST_TERMINATION"
)

Set of constants representing the allowable values for ComputedUsageSummaryTypeEnum

func GetComputedUsageSummaryTypeEnumValues

func GetComputedUsageSummaryTypeEnumValues() []ComputedUsageSummaryTypeEnum

GetComputedUsageSummaryTypeEnumValues Enumerates the set of values for ComputedUsageSummaryTypeEnum

func GetMappingComputedUsageSummaryTypeEnum

func GetMappingComputedUsageSummaryTypeEnum(val string) (ComputedUsageSummaryTypeEnum, bool)

GetMappingComputedUsageSummaryTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ComputedUsageTypeEnum

type ComputedUsageTypeEnum string

ComputedUsageTypeEnum Enum with underlying type: string

const (
	ComputedUsageTypePromotion                     ComputedUsageTypeEnum = "PROMOTION"
	ComputedUsageTypeDoNotBill                     ComputedUsageTypeEnum = "DO_NOT_BILL"
	ComputedUsageTypeUsage                         ComputedUsageTypeEnum = "USAGE"
	ComputedUsageTypeCommit                        ComputedUsageTypeEnum = "COMMIT"
	ComputedUsageTypeOverage                       ComputedUsageTypeEnum = "OVERAGE"
	ComputedUsageTypePayAsYouGo                    ComputedUsageTypeEnum = "PAY_AS_YOU_GO"
	ComputedUsageTypeMonthlyMinimum                ComputedUsageTypeEnum = "MONTHLY_MINIMUM"
	ComputedUsageTypeDelayedUsageInvoiceTiming     ComputedUsageTypeEnum = "DELAYED_USAGE_INVOICE_TIMING"
	ComputedUsageTypeDelayedUsageCommitmentExp     ComputedUsageTypeEnum = "DELAYED_USAGE_COMMITMENT_EXP"
	ComputedUsageTypeOnAccountCredit               ComputedUsageTypeEnum = "ON_ACCOUNT_CREDIT"
	ComputedUsageTypeServiceCredit                 ComputedUsageTypeEnum = "SERVICE_CREDIT"
	ComputedUsageTypeCommitmentExpiration          ComputedUsageTypeEnum = "COMMITMENT_EXPIRATION"
	ComputedUsageTypeFundedAllocation              ComputedUsageTypeEnum = "FUNDED_ALLOCATION"
	ComputedUsageTypeDonotBillUsagePostTermination ComputedUsageTypeEnum = "DONOT_BILL_USAGE_POST_TERMINATION"
	ComputedUsageTypeDelayedUsagePostTermination   ComputedUsageTypeEnum = "DELAYED_USAGE_POST_TERMINATION"
)

Set of constants representing the allowable values for ComputedUsageTypeEnum

func GetComputedUsageTypeEnumValues

func GetComputedUsageTypeEnumValues() []ComputedUsageTypeEnum

GetComputedUsageTypeEnumValues Enumerates the set of values for ComputedUsageTypeEnum

func GetMappingComputedUsageTypeEnum

func GetMappingComputedUsageTypeEnum(val string) (ComputedUsageTypeEnum, bool)

GetMappingComputedUsageTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type GetComputedUsageRequest

type GetComputedUsageRequest struct {

	// The Computed Usage Id
	ComputedUsageId *string `mandatory:"true" contributesTo:"path" name:"computedUsageId"`

	// The OCID of the root compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Partial response refers to an optimization technique offered
	// by the RESTful web APIs to return only the information
	// (fields) required by the client. This parameter is used to control what fields to
	// return.
	Fields []string `contributesTo:"query" name:"fields" collectionFormat:"multi"`

	// 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 OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
	XOneOriginRegion *string `mandatory:"false" contributesTo:"header" name:"x-one-origin-region"`

	// 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
}

GetComputedUsageRequest wrapper for the GetComputedUsage operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/osubusage/GetComputedUsage.go.html to see an example of how to use GetComputedUsageRequest.

func (GetComputedUsageRequest) BinaryRequestBody

func (request GetComputedUsageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetComputedUsageRequest) HTTPRequest

func (request GetComputedUsageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetComputedUsageRequest) RetryPolicy

func (request GetComputedUsageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetComputedUsageRequest) String

func (request GetComputedUsageRequest) String() string

func (GetComputedUsageRequest) ValidateEnumValue

func (request GetComputedUsageRequest) 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

type GetComputedUsageResponse

type GetComputedUsageResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ComputedUsage instance
	ComputedUsage `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"`
}

GetComputedUsageResponse wrapper for the GetComputedUsage operation

func (GetComputedUsageResponse) HTTPResponse

func (response GetComputedUsageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetComputedUsageResponse) String

func (response GetComputedUsageResponse) String() string

type ListComputedUsageAggregatedsGroupingEnum

type ListComputedUsageAggregatedsGroupingEnum string

ListComputedUsageAggregatedsGroupingEnum Enum with underlying type: string

const (
	ListComputedUsageAggregatedsGroupingHourly  ListComputedUsageAggregatedsGroupingEnum = "HOURLY"
	ListComputedUsageAggregatedsGroupingDaily   ListComputedUsageAggregatedsGroupingEnum = "DAILY"
	ListComputedUsageAggregatedsGroupingMonthly ListComputedUsageAggregatedsGroupingEnum = "MONTHLY"
	ListComputedUsageAggregatedsGroupingNone    ListComputedUsageAggregatedsGroupingEnum = "NONE"
)

Set of constants representing the allowable values for ListComputedUsageAggregatedsGroupingEnum

func GetListComputedUsageAggregatedsGroupingEnumValues

func GetListComputedUsageAggregatedsGroupingEnumValues() []ListComputedUsageAggregatedsGroupingEnum

GetListComputedUsageAggregatedsGroupingEnumValues Enumerates the set of values for ListComputedUsageAggregatedsGroupingEnum

func GetMappingListComputedUsageAggregatedsGroupingEnum

func GetMappingListComputedUsageAggregatedsGroupingEnum(val string) (ListComputedUsageAggregatedsGroupingEnum, bool)

GetMappingListComputedUsageAggregatedsGroupingEnum performs case Insensitive comparison on enum value and return the desired enum

type ListComputedUsageAggregatedsRequest

type ListComputedUsageAggregatedsRequest struct {

	// The OCID of the root compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM.
	SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`

	// Initial date to filter Computed Usage data in SPM. In the case of non aggregated data the time period between of fromDate and toDate , expressed in RFC 3339 timestamp format.
	TimeFrom *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeFrom"`

	// Final date to filter Computed Usage data in SPM, expressed in RFC 3339 timestamp format.
	TimeTo *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeTo"`

	// Product part number for subscribed service line, called parent product.
	ParentProduct *string `mandatory:"false" contributesTo:"query" name:"parentProduct"`

	// Grouping criteria to use for aggregate the computed Usage, either hourly (`HOURLY`), daily (`DAILY`), monthly(`MONTHLY`) or none (`NONE`) to not follow a grouping criteria by date.
	Grouping ListComputedUsageAggregatedsGroupingEnum `mandatory:"false" contributesTo:"query" name:"grouping" omitEmpty:"true"`

	// The maximum number aggregatedComputedUsages of items to return within the Subscription "List" call, this
	// counts the overall count across all items
	// Example: `500`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// 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 OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
	XOneOriginRegion *string `mandatory:"false" contributesTo:"header" name:"x-one-origin-region"`

	// 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
}

ListComputedUsageAggregatedsRequest wrapper for the ListComputedUsageAggregateds operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/osubusage/ListComputedUsageAggregateds.go.html to see an example of how to use ListComputedUsageAggregatedsRequest.

func (ListComputedUsageAggregatedsRequest) BinaryRequestBody

func (request ListComputedUsageAggregatedsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListComputedUsageAggregatedsRequest) HTTPRequest

func (request ListComputedUsageAggregatedsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListComputedUsageAggregatedsRequest) RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListComputedUsageAggregatedsRequest) String

func (ListComputedUsageAggregatedsRequest) ValidateEnumValue

func (request ListComputedUsageAggregatedsRequest) 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

type ListComputedUsageAggregatedsResponse

type ListComputedUsageAggregatedsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []ComputedUsageAggregatedSummary instances
	Items []ComputedUsageAggregatedSummary `presentIn:"body"`

	// 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"`

	// 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"`
}

ListComputedUsageAggregatedsResponse wrapper for the ListComputedUsageAggregateds operation

func (ListComputedUsageAggregatedsResponse) HTTPResponse

func (response ListComputedUsageAggregatedsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListComputedUsageAggregatedsResponse) String

func (response ListComputedUsageAggregatedsResponse) String() string

type ListComputedUsagesRequest

type ListComputedUsagesRequest struct {

	// The OCID of the root compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM.
	SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`

	// Initial date to filter Computed Usage data in SPM. In the case of non aggregated data the time period between of fromDate and toDate , expressed in RFC 3339 timestamp format.
	TimeFrom *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeFrom"`

	// Final date to filter Computed Usage data in SPM, expressed in RFC 3339 timestamp format.
	TimeTo *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeTo"`

	// Product part number for subscribed service line, called parent product.
	ParentProduct *string `mandatory:"false" contributesTo:"query" name:"parentProduct"`

	// Product part number for Computed Usage .
	ComputedProduct *string `mandatory:"false" contributesTo:"query" name:"computedProduct"`

	// The maximum number of items to return in a paginated "List" call.
	// Example: `500`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListComputedUsagesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide one sort order (`sortOrder`).
	SortBy ListComputedUsagesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// 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 OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
	XOneOriginRegion *string `mandatory:"false" contributesTo:"header" name:"x-one-origin-region"`

	// 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
}

ListComputedUsagesRequest wrapper for the ListComputedUsages operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/osubusage/ListComputedUsages.go.html to see an example of how to use ListComputedUsagesRequest.

func (ListComputedUsagesRequest) BinaryRequestBody

func (request ListComputedUsagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListComputedUsagesRequest) HTTPRequest

func (request ListComputedUsagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListComputedUsagesRequest) RetryPolicy

func (request ListComputedUsagesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListComputedUsagesRequest) String

func (request ListComputedUsagesRequest) String() string

func (ListComputedUsagesRequest) ValidateEnumValue

func (request ListComputedUsagesRequest) 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

type ListComputedUsagesResponse

type ListComputedUsagesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []ComputedUsageSummary instances
	Items []ComputedUsageSummary `presentIn:"body"`

	// 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"`

	// 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"`
}

ListComputedUsagesResponse wrapper for the ListComputedUsages operation

func (ListComputedUsagesResponse) HTTPResponse

func (response ListComputedUsagesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListComputedUsagesResponse) String

func (response ListComputedUsagesResponse) String() string

type ListComputedUsagesSortByEnum

type ListComputedUsagesSortByEnum string

ListComputedUsagesSortByEnum Enum with underlying type: string

const (
	ListComputedUsagesSortByTimecreated   ListComputedUsagesSortByEnum = "timeCreated"
	ListComputedUsagesSortByTimeofarrival ListComputedUsagesSortByEnum = "timeOfArrival"
	ListComputedUsagesSortByTimemeteredon ListComputedUsagesSortByEnum = "timeMeteredOn"
)

Set of constants representing the allowable values for ListComputedUsagesSortByEnum

func GetListComputedUsagesSortByEnumValues

func GetListComputedUsagesSortByEnumValues() []ListComputedUsagesSortByEnum

GetListComputedUsagesSortByEnumValues Enumerates the set of values for ListComputedUsagesSortByEnum

func GetMappingListComputedUsagesSortByEnum

func GetMappingListComputedUsagesSortByEnum(val string) (ListComputedUsagesSortByEnum, bool)

GetMappingListComputedUsagesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListComputedUsagesSortOrderEnum

type ListComputedUsagesSortOrderEnum string

ListComputedUsagesSortOrderEnum Enum with underlying type: string

const (
	ListComputedUsagesSortOrderAsc  ListComputedUsagesSortOrderEnum = "ASC"
	ListComputedUsagesSortOrderDesc ListComputedUsagesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListComputedUsagesSortOrderEnum

func GetListComputedUsagesSortOrderEnumValues

func GetListComputedUsagesSortOrderEnumValues() []ListComputedUsagesSortOrderEnum

GetListComputedUsagesSortOrderEnumValues Enumerates the set of values for ListComputedUsagesSortOrderEnum

func GetMappingListComputedUsagesSortOrderEnum

func GetMappingListComputedUsagesSortOrderEnum(val string) (ListComputedUsagesSortOrderEnum, bool)

GetMappingListComputedUsagesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type Product

type Product struct {

	// Product part number
	PartNumber *string `mandatory:"true" json:"partNumber"`

	// Product name
	Name *string `mandatory:"true" json:"name"`

	// Unit of Measure
	UnitOfMeasure *string `mandatory:"false" json:"unitOfMeasure"`

	// Product provisioning group
	ProvisioningGroup *string `mandatory:"false" json:"provisioningGroup"`

	// Metered service billing category
	BillingCategory *string `mandatory:"false" json:"billingCategory"`

	// Product category
	ProductCategory *string `mandatory:"false" json:"productCategory"`

	// Rate card part type of Product
	UcmRateCardPartType *string `mandatory:"false" json:"ucmRateCardPartType"`
}

Product Product description

func (Product) String

func (m Product) String() string

func (Product) ValidateEnumValue

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL