usageapi

package
v24.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Sep 8, 2020 License: Apache-2.0, UPL-1.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Configuration 

type Configuration struct {

	// The key of the config
	Key *string `mandatory:"true" json:"key"`

	// The value of the config
	Values []string `mandatory:"false" json:"values"`
}

Configuration A configuration

func (Configuration) String 

func (m Configuration) String() string

type ConfigurationAggregation 

type ConfigurationAggregation struct {

	// The list of available configurations
	Items []Configuration `mandatory:"true" json:"items"`
}

ConfigurationAggregation The available configurations

func (ConfigurationAggregation) String 

func (m ConfigurationAggregation) String() string

type Dimension 

type Dimension struct {

	// The key of the dimension.
	Key *string `mandatory:"true" json:"key"`

	// The value of the dimension.
	Value *string `mandatory:"true" json:"value"`
}

Dimension The dimension use for filtering. example: `[{value: "COMPUTE", key: "service"}]`

func (Dimension) String 

func (m Dimension) String() string

type Filter 

type Filter struct {

	// The operator of the filter. 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"`
}

Filter The filter object for query usage.

func (Filter) String 

func (m Filter) String() string

type FilterOperatorEnum 

type FilterOperatorEnum string

FilterOperatorEnum Enum with underlying type: string 

const (
	FilterOperatorAnd FilterOperatorEnum = "AND"
	FilterOperatorNot FilterOperatorEnum = "NOT"
	FilterOperatorOr  FilterOperatorEnum = "OR"
)

Set of constants representing the allowable values for FilterOperatorEnum

func GetFilterOperatorEnumValues 

func GetFilterOperatorEnumValues() []FilterOperatorEnum

GetFilterOperatorEnumValues Enumerates the set of values for FilterOperatorEnum

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

RequestSummarizedConfigurationsRequest wrapper for the RequestSummarizedConfigurations operation

func (RequestSummarizedConfigurationsRequest) HTTPRequest 

func (request RequestSummarizedConfigurationsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RequestSummarizedConfigurationsRequest) RetryPolicy 

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

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

func (RequestSummarizedConfigurationsRequest) String 

func (request RequestSummarizedConfigurationsRequest) String() string

type RequestSummarizedConfigurationsResponse 

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

RequestSummarizedConfigurationsResponse wrapper for the RequestSummarizedConfigurations operation

func (RequestSummarizedConfigurationsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (RequestSummarizedConfigurationsResponse) String 

func (response RequestSummarizedConfigurationsResponse) String() string

type RequestSummarizedUsagesDetails 

type RequestSummarizedUsagesDetails struct {

	// tenant id
	TenantId *string `mandatory:"true" json:"tenantId"`

	// The start time of the usage.
	TimeUsageStarted *common.SDKTime `mandatory:"true" json:"timeUsageStarted"`

	// The end time of the usage.
	TimeUsageEnded *common.SDKTime `mandatory:"true" json:"timeUsageEnded"`

	// The granularity of the usage.
	// HOURLY - Hourly aggregation of data
	// DAILY - Daily aggregation of data
	// MONTHLY - Monthly aggregation of data
	// TOTAL - Not Supported Yet
	Granularity RequestSummarizedUsagesDetailsGranularityEnum `mandatory:"true" json:"granularity"`

	// The type of query of the usage.
	// 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 depth level of the compartment.
	CompartmentDepth *float32 `mandatory:"false" json:"compartmentDepth"`

	Filter *Filter `mandatory:"false" json:"filter"`
}

RequestSummarizedUsagesDetails details for the '/usage' query

func (RequestSummarizedUsagesDetails) String 

func (m RequestSummarizedUsagesDetails) String() string

type RequestSummarizedUsagesDetailsGranularityEnum 

type RequestSummarizedUsagesDetailsGranularityEnum string

RequestSummarizedUsagesDetailsGranularityEnum Enum with underlying type: string 

const (
	RequestSummarizedUsagesDetailsGranularityHourly  RequestSummarizedUsagesDetailsGranularityEnum = "HOURLY"
	RequestSummarizedUsagesDetailsGranularityDaily   RequestSummarizedUsagesDetailsGranularityEnum = "DAILY"
	RequestSummarizedUsagesDetailsGranularityMonthly RequestSummarizedUsagesDetailsGranularityEnum = "MONTHLY"
	RequestSummarizedUsagesDetailsGranularityTotal   RequestSummarizedUsagesDetailsGranularityEnum = "TOTAL"
)

Set of constants representing the allowable values for RequestSummarizedUsagesDetailsGranularityEnum

func GetRequestSummarizedUsagesDetailsGranularityEnumValues 

func GetRequestSummarizedUsagesDetailsGranularityEnumValues() []RequestSummarizedUsagesDetailsGranularityEnum

GetRequestSummarizedUsagesDetailsGranularityEnumValues Enumerates the set of values for RequestSummarizedUsagesDetailsGranularityEnum

type RequestSummarizedUsagesDetailsQueryTypeEnum 

type RequestSummarizedUsagesDetailsQueryTypeEnum string

RequestSummarizedUsagesDetailsQueryTypeEnum Enum with underlying type: string 

const (
	RequestSummarizedUsagesDetailsQueryTypeUsage RequestSummarizedUsagesDetailsQueryTypeEnum = "USAGE"
	RequestSummarizedUsagesDetailsQueryTypeCost  RequestSummarizedUsagesDetailsQueryTypeEnum = "COST"
)

Set of constants representing the allowable values for RequestSummarizedUsagesDetailsQueryTypeEnum

func GetRequestSummarizedUsagesDetailsQueryTypeEnumValues 

func GetRequestSummarizedUsagesDetailsQueryTypeEnumValues() []RequestSummarizedUsagesDetailsQueryTypeEnum

GetRequestSummarizedUsagesDetailsQueryTypeEnumValues Enumerates the set of values for RequestSummarizedUsagesDetailsQueryTypeEnum

type RequestSummarizedUsagesRequest 

type RequestSummarizedUsagesRequest struct {

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

RequestSummarizedUsagesRequest wrapper for the RequestSummarizedUsages operation

func (RequestSummarizedUsagesRequest) HTTPRequest 

func (request RequestSummarizedUsagesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RequestSummarizedUsagesRequest) RetryPolicy 

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

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

func (RequestSummarizedUsagesRequest) String 

func (request RequestSummarizedUsagesRequest) String() string

type RequestSummarizedUsagesResponse 

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

RequestSummarizedUsagesResponse wrapper for the RequestSummarizedUsages operation

func (RequestSummarizedUsagesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (RequestSummarizedUsagesResponse) String 

func (response RequestSummarizedUsagesResponse) String() string

type Tag 

type Tag struct {

	// The tag namespace.
	Namespace *string `mandatory:"false" json:"namespace"`

	// The key of the tag.
	Key *string `mandatory:"false" json:"key"`

	// The value of the tag.
	Value *string `mandatory:"false" json:"value"`
}

Tag The tag use for filtering.

func (Tag) String 

func (m Tag) String() string

type UsageAggregation 

type UsageAggregation struct {

	// A list of usage items.
	Items []UsageSummary `mandatory:"true" json:"items"`

	// Aggregate the result by.
	GroupBy []string `mandatory:"false" json:"groupBy"`
}

UsageAggregation The usage of the account (tenant)

func (UsageAggregation) String 

func (m UsageAggregation) String() string

type UsageSummary 

type UsageSummary struct {

	// The start time of the usage.
	TimeUsageStarted *common.SDKTime `mandatory:"true" json:"timeUsageStarted"`

	// The end time of the usage.
	TimeUsageEnded *common.SDKTime `mandatory:"true" json:"timeUsageEnded"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The path of the compartment, starting from root.
	CompartmentPath *string `mandatory:"false" json:"compartmentPath"`

	// The name of the compartment.
	CompartmentName *string `mandatory:"false" json:"compartmentName"`

	// The name of the service that is incurring the cost.
	Service *string `mandatory:"false" json:"service"`

	// The name of the resource that is incurring the cost.
	ResourceName *string `mandatory:"false" json:"resourceName"`

	// The Ocid of the resource 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 size of resource being metered.
	Weight *float32 `mandatory:"false" json:"weight"`

	// The shape of the resource.
	Shape *string `mandatory:"false" json:"shape"`

	// The part number of the SKU.
	SkuPartNumber *string `mandatory:"false" json:"skuPartNumber"`

	// The friendly name for the SKU.
	SkuName *string `mandatory:"false" json:"skuName"`

	// The unit of the usage.
	Unit *string `mandatory:"false" json:"unit"`

	// The discretionary discount applied to the SKU.
	Discount *float32 `mandatory:"false" json:"discount"`

	// The list rate for the SKU (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 currency for the price.
	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"`
}

UsageSummary The result from usage store.

func (UsageSummary) String 

func (m UsageSummary) String() string

type UsageapiClient 

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

UsageapiClient a client for Usageapi

func NewUsageapiClientWithConfigurationProvider 

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 

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 (*UsageapiClient) ConfigurationProvider 

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

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

func (UsageapiClient) RequestSummarizedConfigurations 

func (client UsageapiClient) RequestSummarizedConfigurations(ctx context.Context, request RequestSummarizedConfigurationsRequest) (response RequestSummarizedConfigurationsResponse, err error)

RequestSummarizedConfigurations Returns the list of config for UI dropdown list

func (UsageapiClient) RequestSummarizedUsages 

func (client UsageapiClient) RequestSummarizedUsages(ctx context.Context, request RequestSummarizedUsagesRequest) (response RequestSummarizedUsagesResponse, err error)

RequestSummarizedUsages Returns the usage for the given account

func (*UsageapiClient) SetRegion 

func (client *UsageapiClient) SetRegion(region string)

SetRegion overrides the region of this client.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.