Configuration A configuration.
type Configuration struct { // The configuration key. Key *string `mandatory:"true" json:"key"` // The configuration value. Values []string `mandatory:"false" json:"values"` }
func (m Configuration) String() string
ConfigurationAggregation The available configurations.
type ConfigurationAggregation struct { // The list of available configurations. Items []Configuration `mandatory:"true" json:"items"` }
func (m ConfigurationAggregation) String() string
Dimension The dimension used for filtering. availabe dimension are "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" example: `[{value: "COMPUTE", key: "service"}]`
type Dimension struct { // The dimension key. Key *string `mandatory:"true" json:"key"` // The dimension value. Value *string `mandatory:"true" json:"value"` }
func (m Dimension) String() string
Filter The filter object for query usage.
type Filter struct { // The filter operator. Example: 'AND', 'OR', 'NOT'. Operator FilterOperatorEnum `mandatory:"false" json:"operator,omitempty"` // The dimensions to filter on. Dimensions []Dimension `mandatory:"false" json:"dimensions"` // The tags to filter on. Tags []Tag `mandatory:"false" json:"tags"` // The nested filter object. Filters []Filter `mandatory:"false" json:"filters"` }
func (m Filter) String() string
FilterOperatorEnum Enum with underlying type: string
type FilterOperatorEnum string
Set of constants representing the allowable values for FilterOperatorEnum
const ( FilterOperatorAnd FilterOperatorEnum = "AND" FilterOperatorNot FilterOperatorEnum = "NOT" FilterOperatorOr FilterOperatorEnum = "OR" )
func GetFilterOperatorEnumValues() []FilterOperatorEnum
GetFilterOperatorEnumValues Enumerates the set of values for FilterOperatorEnum
RequestSummarizedConfigurationsRequest wrapper for the RequestSummarizedConfigurations operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/usageapi/RequestSummarizedConfigurations.go.html to see an example of how to use RequestSummarizedConfigurationsRequest.
type RequestSummarizedConfigurationsRequest struct { // tenant id TenantId *string `mandatory:"true" contributesTo:"query" name:"tenantId"` // 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 RequestSummarizedConfigurationsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestSummarizedConfigurationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestSummarizedConfigurationsRequest) String() string
RequestSummarizedConfigurationsResponse wrapper for the RequestSummarizedConfigurations operation
type RequestSummarizedConfigurationsResponse struct { // The underlying http response RawResponse *http.Response // The ConfigurationAggregation instance ConfigurationAggregation `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"` }
func (response RequestSummarizedConfigurationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestSummarizedConfigurationsResponse) String() string
RequestSummarizedUsagesDetails Details for the '/usage' query.
type RequestSummarizedUsagesDetails struct { // Tenant ID TenantId *string `mandatory:"true" json:"tenantId"` // The usage start time. TimeUsageStarted *common.SDKTime `mandatory:"true" json:"timeUsageStarted"` // The usage end time. TimeUsageEnded *common.SDKTime `mandatory:"true" json:"timeUsageEnded"` // The usage granularity. // HOURLY - Hourly data aggregation. // DAILY - Daily data aggregation. // MONTHLY - Monthly data aggregation. // TOTAL - Not yet supported. Granularity RequestSummarizedUsagesDetailsGranularityEnum `mandatory:"true" json:"granularity"` // The query usage type. // Usage - Query the usage data. // Cost - Query the cost/billing data. QueryType RequestSummarizedUsagesDetailsQueryTypeEnum `mandatory:"false" json:"queryType,omitempty"` // Aggregate the result by. // example: // `["service"]` GroupBy []string `mandatory:"false" json:"groupBy"` // The compartment depth level. CompartmentDepth *float32 `mandatory:"false" json:"compartmentDepth"` Filter *Filter `mandatory:"false" json:"filter"` }
func (m RequestSummarizedUsagesDetails) String() string
RequestSummarizedUsagesDetailsGranularityEnum Enum with underlying type: string
type RequestSummarizedUsagesDetailsGranularityEnum string
Set of constants representing the allowable values for RequestSummarizedUsagesDetailsGranularityEnum
const ( RequestSummarizedUsagesDetailsGranularityHourly RequestSummarizedUsagesDetailsGranularityEnum = "HOURLY" RequestSummarizedUsagesDetailsGranularityDaily RequestSummarizedUsagesDetailsGranularityEnum = "DAILY" RequestSummarizedUsagesDetailsGranularityMonthly RequestSummarizedUsagesDetailsGranularityEnum = "MONTHLY" RequestSummarizedUsagesDetailsGranularityTotal RequestSummarizedUsagesDetailsGranularityEnum = "TOTAL" )
func GetRequestSummarizedUsagesDetailsGranularityEnumValues() []RequestSummarizedUsagesDetailsGranularityEnum
GetRequestSummarizedUsagesDetailsGranularityEnumValues Enumerates the set of values for RequestSummarizedUsagesDetailsGranularityEnum
RequestSummarizedUsagesDetailsQueryTypeEnum Enum with underlying type: string
type RequestSummarizedUsagesDetailsQueryTypeEnum string
Set of constants representing the allowable values for RequestSummarizedUsagesDetailsQueryTypeEnum
const ( RequestSummarizedUsagesDetailsQueryTypeUsage RequestSummarizedUsagesDetailsQueryTypeEnum = "USAGE" RequestSummarizedUsagesDetailsQueryTypeCost RequestSummarizedUsagesDetailsQueryTypeEnum = "COST" )
func GetRequestSummarizedUsagesDetailsQueryTypeEnumValues() []RequestSummarizedUsagesDetailsQueryTypeEnum
GetRequestSummarizedUsagesDetailsQueryTypeEnumValues Enumerates the set of values for RequestSummarizedUsagesDetailsQueryTypeEnum
RequestSummarizedUsagesRequest wrapper for the RequestSummarizedUsages operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/usageapi/RequestSummarizedUsages.go.html to see an example of how to use RequestSummarizedUsagesRequest.
type RequestSummarizedUsagesRequest struct { // getUsageRequest contains query inforamtion. RequestSummarizedUsagesDetails `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"` // The page token representing the page at which to start retrieving results. // This is usually retrieved from a previous list call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The maximum number of items to return. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // 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 RequestSummarizedUsagesRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestSummarizedUsagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestSummarizedUsagesRequest) String() string
RequestSummarizedUsagesResponse wrapper for the RequestSummarizedUsages operation
type RequestSummarizedUsagesResponse struct { // The underlying http response RawResponse *http.Response // A list of UsageAggregation instances UsageAggregation `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For pagination of a list of items. When paging through a list, if this header appears in the response, // then a partial list might have been returned. Include this value as the `page` parameter for the // subsequent GET request to get the next batch of items. OpcNextPage *string `presentIn:"header" name:"opc-next-page"` }
func (response RequestSummarizedUsagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestSummarizedUsagesResponse) String() string
Tag The tag used for filtering.
type Tag struct { // The tag namespace. Namespace *string `mandatory:"false" json:"namespace"` // The tag key. Key *string `mandatory:"false" json:"key"` // The tag value. Value *string `mandatory:"false" json:"value"` }
func (m Tag) String() string
UsageAggregation The account (tenant) usage.
type UsageAggregation struct { // A list of usage items. Items []UsageSummary `mandatory:"true" json:"items"` // Aggregate the result by. GroupBy []string `mandatory:"false" json:"groupBy"` }
func (m UsageAggregation) String() string
UsageSummary The usage store result.
type UsageSummary struct { // The usage start time. TimeUsageStarted *common.SDKTime `mandatory:"true" json:"timeUsageStarted"` // The usage end time. TimeUsageEnded *common.SDKTime `mandatory:"true" json:"timeUsageEnded"` // The tenancy OCID. TenantId *string `mandatory:"false" json:"tenantId"` // The tenancy name. TenantName *string `mandatory:"false" json:"tenantName"` // The compartment OCID. CompartmentId *string `mandatory:"false" json:"compartmentId"` // The compartment path, starting from root. CompartmentPath *string `mandatory:"false" json:"compartmentPath"` // The compartment name. CompartmentName *string `mandatory:"false" json:"compartmentName"` // The service name that is incurring the cost. Service *string `mandatory:"false" json:"service"` // The resource name that is incurring the cost. ResourceName *string `mandatory:"false" json:"resourceName"` // The resource OCID that is incurring the cost. ResourceId *string `mandatory:"false" json:"resourceId"` // The region of the usage. Region *string `mandatory:"false" json:"region"` // The availability domain of the usage. Ad *string `mandatory:"false" json:"ad"` // The resource size being metered. Weight *float32 `mandatory:"false" json:"weight"` // The resource shape. Shape *string `mandatory:"false" json:"shape"` // The SKU part number. SkuPartNumber *string `mandatory:"false" json:"skuPartNumber"` // The SKU friendly name. SkuName *string `mandatory:"false" json:"skuName"` // The usage unit. Unit *string `mandatory:"false" json:"unit"` // The discretionary discount applied to the SKU. Discount *float32 `mandatory:"false" json:"discount"` // The SKU list rate (not discount). ListRate *float32 `mandatory:"false" json:"listRate"` // Platform for the cost. Platform *string `mandatory:"false" json:"platform"` // The computed cost. ComputedAmount *float32 `mandatory:"false" json:"computedAmount"` // The usage number. ComputedQuantity *float32 `mandatory:"false" json:"computedQuantity"` // The SPM OverageFlag. OveragesFlag *string `mandatory:"false" json:"overagesFlag"` // The price per unit. UnitPrice *float32 `mandatory:"false" json:"unitPrice"` // The price currency. Currency *string `mandatory:"false" json:"currency"` // The subscription ID. SubscriptionId *string `mandatory:"false" json:"subscriptionId"` // The overage usage. Overage *string `mandatory:"false" json:"overage"` // For grouping, a tag definition. For filtering, a definition and key. Tags []Tag `mandatory:"false" json:"tags"` }
func (m UsageSummary) String() string
UsageapiClient a client for Usageapi
type UsageapiClient struct { common.BaseClient // contains filtered or unexported fields }
func NewUsageapiClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client UsageapiClient, err error)
NewUsageapiClientWithConfigurationProvider Creates a new default Usageapi client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewUsageapiClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client UsageapiClient, err error)
NewUsageapiClientWithOboToken Creates a new default Usageapi 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 *UsageapiClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client UsageapiClient) RequestSummarizedConfigurations(ctx context.Context, request RequestSummarizedConfigurationsRequest) (response RequestSummarizedConfigurationsResponse, err error)
RequestSummarizedConfigurations Returns the configurations list for the UI drop-down list.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/usageapi/RequestSummarizedConfigurations.go.html to see an example of how to use RequestSummarizedConfigurations API.
func (client UsageapiClient) RequestSummarizedUsages(ctx context.Context, request RequestSummarizedUsagesRequest) (response RequestSummarizedUsagesResponse, err error)
RequestSummarizedUsages Returns usage for the given account.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/usageapi/RequestSummarizedUsages.go.html to see an example of how to use RequestSummarizedUsages API.
func (client *UsageapiClient) SetRegion(region string)
SetRegion overrides the region of this client.