func GetCostAnalysisUiGraphEnumStringValues() []string
GetCostAnalysisUiGraphEnumStringValues Enumerates the set of values in String for CostAnalysisUiGraphEnum
func GetCreateScheduleDetailsOutputFileFormatEnumStringValues() []string
GetCreateScheduleDetailsOutputFileFormatEnumStringValues Enumerates the set of values in String for CreateScheduleDetailsOutputFileFormatEnum
func GetDateRangeDateRangeTypeEnumStringValues() []string
GetDateRangeDateRangeTypeEnumStringValues Enumerates the set of values in String for DateRangeDateRangeTypeEnum
func GetDynamicDateRangeDynamicDateRangeTypeEnumStringValues() []string
GetDynamicDateRangeDynamicDateRangeTypeEnumStringValues Enumerates the set of values in String for DynamicDateRangeDynamicDateRangeTypeEnum
func GetFilterOperatorEnumStringValues() []string
GetFilterOperatorEnumStringValues Enumerates the set of values in String for FilterOperatorEnum
func GetForecastForecastTypeEnumStringValues() []string
GetForecastForecastTypeEnumStringValues Enumerates the set of values in String for ForecastForecastTypeEnum
func GetListCustomTablesSortByEnumStringValues() []string
GetListCustomTablesSortByEnumStringValues Enumerates the set of values in String for ListCustomTablesSortByEnum
func GetListCustomTablesSortOrderEnumStringValues() []string
GetListCustomTablesSortOrderEnumStringValues Enumerates the set of values in String for ListCustomTablesSortOrderEnum
func GetListQueriesSortByEnumStringValues() []string
GetListQueriesSortByEnumStringValues Enumerates the set of values in String for ListQueriesSortByEnum
func GetListQueriesSortOrderEnumStringValues() []string
GetListQueriesSortOrderEnumStringValues Enumerates the set of values in String for ListQueriesSortOrderEnum
func GetListScheduledRunsSortByEnumStringValues() []string
GetListScheduledRunsSortByEnumStringValues Enumerates the set of values in String for ListScheduledRunsSortByEnum
func GetListScheduledRunsSortOrderEnumStringValues() []string
GetListScheduledRunsSortOrderEnumStringValues Enumerates the set of values in String for ListScheduledRunsSortOrderEnum
func GetListSchedulesSortByEnumStringValues() []string
GetListSchedulesSortByEnumStringValues Enumerates the set of values in String for ListSchedulesSortByEnum
func GetListSchedulesSortOrderEnumStringValues() []string
GetListSchedulesSortOrderEnumStringValues Enumerates the set of values in String for ListSchedulesSortOrderEnum
func GetListUsageCarbonEmissionsQueriesSortByEnumStringValues() []string
GetListUsageCarbonEmissionsQueriesSortByEnumStringValues Enumerates the set of values in String for ListUsageCarbonEmissionsQueriesSortByEnum
func GetListUsageCarbonEmissionsQueriesSortOrderEnumStringValues() []string
GetListUsageCarbonEmissionsQueriesSortOrderEnumStringValues Enumerates the set of values in String for ListUsageCarbonEmissionsQueriesSortOrderEnum
func GetQueryPropertiesGranularityEnumStringValues() []string
GetQueryPropertiesGranularityEnumStringValues Enumerates the set of values in String for QueryPropertiesGranularityEnum
func GetQueryPropertiesQueryTypeEnumStringValues() []string
GetQueryPropertiesQueryTypeEnumStringValues Enumerates the set of values in String for QueryPropertiesQueryTypeEnum
func GetReportQueryDateRangeNameEnumStringValues() []string
GetReportQueryDateRangeNameEnumStringValues Enumerates the set of values in String for ReportQueryDateRangeNameEnum
func GetReportQueryGranularityEnumStringValues() []string
GetReportQueryGranularityEnumStringValues Enumerates the set of values in String for ReportQueryGranularityEnum
func GetReportQueryQueryTypeEnumStringValues() []string
GetReportQueryQueryTypeEnumStringValues Enumerates the set of values in String for ReportQueryQueryTypeEnum
func GetRequestSummarizedUsagesDetailsGranularityEnumStringValues() []string
GetRequestSummarizedUsagesDetailsGranularityEnumStringValues Enumerates the set of values in String for RequestSummarizedUsagesDetailsGranularityEnum
func GetRequestSummarizedUsagesDetailsQueryTypeEnumStringValues() []string
GetRequestSummarizedUsagesDetailsQueryTypeEnumStringValues Enumerates the set of values in String for RequestSummarizedUsagesDetailsQueryTypeEnum
func GetResultLocationLocationTypeEnumStringValues() []string
GetResultLocationLocationTypeEnumStringValues Enumerates the set of values in String for ResultLocationLocationTypeEnum
func GetScheduleLifecycleStateEnumStringValues() []string
GetScheduleLifecycleStateEnumStringValues Enumerates the set of values in String for ScheduleLifecycleStateEnum
func GetScheduleOutputFileFormatEnumStringValues() []string
GetScheduleOutputFileFormatEnumStringValues Enumerates the set of values in String for ScheduleOutputFileFormatEnum
func GetScheduledRunLifecycleStateEnumStringValues() []string
GetScheduledRunLifecycleStateEnumStringValues Enumerates the set of values in String for ScheduledRunLifecycleStateEnum
func GetUpdateScheduleDetailsOutputFileFormatEnumStringValues() []string
GetUpdateScheduleDetailsOutputFileFormatEnumStringValues Enumerates the set of values in String for UpdateScheduleDetailsOutputFileFormatEnum
func GetUsageCarbonEmissionsReportQueryDateRangeNameEnumStringValues() []string
GetUsageCarbonEmissionsReportQueryDateRangeNameEnumStringValues Enumerates the set of values in String for UsageCarbonEmissionsReportQueryDateRangeNameEnum
AverageCarbonEmission Average carbon emission.
type AverageCarbonEmission struct {
// The sku part number.
SkuPartNumber *string `mandatory:"true" json:"skuPartNumber"`
// The average carbon emissions by SKU.
AverageCarbonEmission *float64 `mandatory:"true" json:"averageCarbonEmission"`
}
func (m AverageCarbonEmission) String() string
func (m AverageCarbonEmission) 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
CleanEnergyUsage Clean energy usage.
type CleanEnergyUsage struct {
// The region.
Region *string `mandatory:"true" json:"region"`
// The percentage of clean enery used.
Usage *float64 `mandatory:"true" json:"usage"`
// The availability domain.
Ad *string `mandatory:"false" json:"ad"`
}
func (m CleanEnergyUsage) String() string
func (m CleanEnergyUsage) 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
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
func (m Configuration) 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
ConfigurationAggregation The available configurations.
type ConfigurationAggregation struct {
// The list of available configurations.
Items []Configuration `mandatory:"true" json:"items"`
}
func (m ConfigurationAggregation) String() string
func (m ConfigurationAggregation) 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
CostAnalysisUi The common fields for Cost Analysis UI rendering.
type CostAnalysisUi struct {
// The graph type.
Graph CostAnalysisUiGraphEnum `mandatory:"false" json:"graph,omitempty"`
// A cumulative graph.
IsCumulativeGraph *bool `mandatory:"false" json:"isCumulativeGraph"`
}
func (m CostAnalysisUi) String() string
func (m CostAnalysisUi) 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
CostAnalysisUiGraphEnum Enum with underlying type: string
type CostAnalysisUiGraphEnum string
Set of constants representing the allowable values for CostAnalysisUiGraphEnum
const (
CostAnalysisUiGraphBars CostAnalysisUiGraphEnum = "BARS"
CostAnalysisUiGraphLines CostAnalysisUiGraphEnum = "LINES"
CostAnalysisUiGraphStackedLines CostAnalysisUiGraphEnum = "STACKED_LINES"
)
func GetCostAnalysisUiGraphEnumValues() []CostAnalysisUiGraphEnum
GetCostAnalysisUiGraphEnumValues Enumerates the set of values for CostAnalysisUiGraphEnum
func GetMappingCostAnalysisUiGraphEnum(val string) (CostAnalysisUiGraphEnum, bool)
GetMappingCostAnalysisUiGraphEnum performs case Insensitive comparison on enum value and return the desired enum
CreateCustomTableDetails New custom table detail.
type CreateCustomTableDetails struct {
// The compartment OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The associated saved report OCID.
SavedReportId *string `mandatory:"true" json:"savedReportId"`
SavedCustomTable *SavedCustomTable `mandatory:"true" json:"savedCustomTable"`
}
func (m CreateCustomTableDetails) String() string
func (m CreateCustomTableDetails) 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
CreateCustomTableRequest wrapper for the CreateCustomTable operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/CreateCustomTable.go.html to see an example of how to use CreateCustomTableRequest.
type CreateCustomTableRequest struct {
// New custom table details.
CreateCustomTableDetails `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. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateCustomTableRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCustomTableRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCustomTableRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCustomTableRequest) String() string
func (request CreateCustomTableRequest) 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
CreateCustomTableResponse wrapper for the CreateCustomTable operation
type CreateCustomTableResponse struct {
// The underlying http response
RawResponse *http.Response
// The CustomTable instance
CustomTable `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 CreateCustomTableResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCustomTableResponse) String() string
CreateQueryDetails New query detail with savedRequestSummarizedUsagesDetails, savedCostAnalysisUI, and displayName.
type CreateQueryDetails struct {
// The compartment OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
QueryDefinition *QueryDefinition `mandatory:"true" json:"queryDefinition"`
}
func (m CreateQueryDetails) String() string
func (m CreateQueryDetails) 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
CreateQueryRequest wrapper for the CreateQuery operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/CreateQuery.go.html to see an example of how to use CreateQueryRequest.
type CreateQueryRequest struct {
// New query details. Up to ten saved queries.
CreateQueryDetails `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. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateQueryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateQueryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateQueryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateQueryRequest) String() string
func (request CreateQueryRequest) 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
CreateQueryResponse wrapper for the CreateQuery operation
type CreateQueryResponse struct {
// The underlying http response
RawResponse *http.Response
// The Query instance
Query `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 CreateQueryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateQueryResponse) String() string
CreateScheduleDetails The saved schedule.
type CreateScheduleDetails struct {
// The unique name of the user-created schedule.
Name *string `mandatory:"true" json:"name"`
// The customer tenancy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
ResultLocation ResultLocation `mandatory:"true" json:"resultLocation"`
// Specifies the frequency according to when the schedule will be run,
// in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10 (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10).
// Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
ScheduleRecurrences *string `mandatory:"true" json:"scheduleRecurrences"`
// The date and time of the first time job execution.
TimeScheduled *common.SDKTime `mandatory:"true" json:"timeScheduled"`
// The description of the schedule.
Description *string `mandatory:"false" json:"description"`
// Specifies the supported output file format.
OutputFileFormat CreateScheduleDetailsOutputFileFormatEnum `mandatory:"false" json:"outputFileFormat,omitempty"`
// The saved report ID which can also be used to generate a query.
SavedReportId *string `mandatory:"false" json:"savedReportId"`
QueryProperties *QueryProperties `mandatory:"false" json:"queryProperties"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// See Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateScheduleDetails) String() string
func (m *CreateScheduleDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateScheduleDetails) 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
CreateScheduleDetailsOutputFileFormatEnum Enum with underlying type: string
type CreateScheduleDetailsOutputFileFormatEnum string
Set of constants representing the allowable values for CreateScheduleDetailsOutputFileFormatEnum
const (
CreateScheduleDetailsOutputFileFormatCsv CreateScheduleDetailsOutputFileFormatEnum = "CSV"
CreateScheduleDetailsOutputFileFormatPdf CreateScheduleDetailsOutputFileFormatEnum = "PDF"
)
func GetCreateScheduleDetailsOutputFileFormatEnumValues() []CreateScheduleDetailsOutputFileFormatEnum
GetCreateScheduleDetailsOutputFileFormatEnumValues Enumerates the set of values for CreateScheduleDetailsOutputFileFormatEnum
func GetMappingCreateScheduleDetailsOutputFileFormatEnum(val string) (CreateScheduleDetailsOutputFileFormatEnum, bool)
GetMappingCreateScheduleDetailsOutputFileFormatEnum performs case Insensitive comparison on enum value and return the desired enum
CreateScheduleRequest wrapper for the CreateSchedule operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/CreateSchedule.go.html to see an example of how to use CreateScheduleRequest.
type CreateScheduleRequest struct {
// New schedule details.
CreateScheduleDetails `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. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateScheduleRequest) String() string
func (request CreateScheduleRequest) 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
CreateScheduleResponse wrapper for the CreateSchedule operation
type CreateScheduleResponse struct {
// The underlying http response
RawResponse *http.Response
// The Schedule instance
Schedule `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 CreateScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateScheduleResponse) String() string
CreateUsageCarbonEmissionsQueryDetails New query detail with savedRequestUsageCarbonEmissionsDetails, savedCostAnalysisUI, and displayName.
type CreateUsageCarbonEmissionsQueryDetails struct {
// The compartment OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
QueryDefinition *UsageCarbonEmissionsQueryDefinition `mandatory:"true" json:"queryDefinition"`
}
func (m CreateUsageCarbonEmissionsQueryDetails) String() string
func (m CreateUsageCarbonEmissionsQueryDetails) 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
CreateUsageCarbonEmissionsQueryRequest wrapper for the CreateUsageCarbonEmissionsQuery operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/CreateUsageCarbonEmissionsQuery.go.html to see an example of how to use CreateUsageCarbonEmissionsQueryRequest.
type CreateUsageCarbonEmissionsQueryRequest struct {
// New query details. Up to ten saved queries.
CreateUsageCarbonEmissionsQueryDetails `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. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateUsageCarbonEmissionsQueryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateUsageCarbonEmissionsQueryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateUsageCarbonEmissionsQueryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateUsageCarbonEmissionsQueryRequest) String() string
func (request CreateUsageCarbonEmissionsQueryRequest) 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
CreateUsageCarbonEmissionsQueryResponse wrapper for the CreateUsageCarbonEmissionsQuery operation
type CreateUsageCarbonEmissionsQueryResponse struct {
// The underlying http response
RawResponse *http.Response
// The UsageCarbonEmissionsQuery instance
UsageCarbonEmissionsQuery `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 CreateUsageCarbonEmissionsQueryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateUsageCarbonEmissionsQueryResponse) String() string
CustomTable The saved custom table.
type CustomTable struct {
// The custom table OCID.
Id *string `mandatory:"true" json:"id"`
// The custom table associated saved report OCID.
SavedReportId *string `mandatory:"false" json:"savedReportId"`
// The custom table compartment OCID.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
SavedCustomTable *SavedCustomTable `mandatory:"false" json:"savedCustomTable"`
}
func (m CustomTable) String() string
func (m CustomTable) 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
CustomTableCollection A custom table list.
type CustomTableCollection struct {
// Custom tables list.
Items []CustomTableSummary `mandatory:"true" json:"items"`
}
func (m CustomTableCollection) String() string
func (m CustomTableCollection) 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
CustomTableSummary Custom table in the list request.
type CustomTableSummary struct {
// The custom table OCID.
Id *string `mandatory:"true" json:"id"`
SavedCustomTable *SavedCustomTable `mandatory:"true" json:"savedCustomTable"`
}
func (m CustomTableSummary) String() string
func (m CustomTableSummary) 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
DateRange Static or dynamic date range `dateRangeType`, which corresponds with type-specific characteristics.
type DateRange interface {
}
DateRangeDateRangeTypeEnum Enum with underlying type: string
type DateRangeDateRangeTypeEnum string
Set of constants representing the allowable values for DateRangeDateRangeTypeEnum
const (
DateRangeDateRangeTypeStatic DateRangeDateRangeTypeEnum = "STATIC"
DateRangeDateRangeTypeDynamic DateRangeDateRangeTypeEnum = "DYNAMIC"
)
func GetDateRangeDateRangeTypeEnumValues() []DateRangeDateRangeTypeEnum
GetDateRangeDateRangeTypeEnumValues Enumerates the set of values for DateRangeDateRangeTypeEnum
func GetMappingDateRangeDateRangeTypeEnum(val string) (DateRangeDateRangeTypeEnum, bool)
GetMappingDateRangeDateRangeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteCustomTableRequest wrapper for the DeleteCustomTable operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/DeleteCustomTable.go.html to see an example of how to use DeleteCustomTableRequest.
type DeleteCustomTableRequest struct {
// The custom table unique OCID.
CustomTableId *string `mandatory:"true" contributesTo:"path" name:"customTableId"`
// 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 will be 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 DeleteCustomTableRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCustomTableRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCustomTableRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCustomTableRequest) String() string
func (request DeleteCustomTableRequest) 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
DeleteCustomTableResponse wrapper for the DeleteCustomTable operation
type DeleteCustomTableResponse 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 DeleteCustomTableResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCustomTableResponse) String() string
DeleteQueryRequest wrapper for the DeleteQuery operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/DeleteQuery.go.html to see an example of how to use DeleteQueryRequest.
type DeleteQueryRequest struct {
// The query unique OCID.
QueryId *string `mandatory:"true" contributesTo:"path" name:"queryId"`
// 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 will be 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 DeleteQueryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteQueryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteQueryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteQueryRequest) String() string
func (request DeleteQueryRequest) 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
DeleteQueryResponse wrapper for the DeleteQuery operation
type DeleteQueryResponse 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 DeleteQueryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteQueryResponse) String() string
DeleteScheduleRequest wrapper for the DeleteSchedule operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/DeleteSchedule.go.html to see an example of how to use DeleteScheduleRequest.
type DeleteScheduleRequest struct {
// The schedule unique OCID.
ScheduleId *string `mandatory:"true" contributesTo:"path" name:"scheduleId"`
// 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 will be 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 DeleteScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteScheduleRequest) String() string
func (request DeleteScheduleRequest) 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
DeleteScheduleResponse wrapper for the DeleteSchedule operation
type DeleteScheduleResponse 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 DeleteScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteScheduleResponse) String() string
DeleteUsageCarbonEmissionsQueryRequest wrapper for the DeleteUsageCarbonEmissionsQuery operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/DeleteUsageCarbonEmissionsQuery.go.html to see an example of how to use DeleteUsageCarbonEmissionsQueryRequest.
type DeleteUsageCarbonEmissionsQueryRequest struct {
// The query unique OCID.
UsageCarbonEmissionsQueryId *string `mandatory:"true" contributesTo:"path" name:"usageCarbonEmissionsQueryId"`
// 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 will be 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 DeleteUsageCarbonEmissionsQueryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteUsageCarbonEmissionsQueryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteUsageCarbonEmissionsQueryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteUsageCarbonEmissionsQueryRequest) String() string
func (request DeleteUsageCarbonEmissionsQueryRequest) 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
DeleteUsageCarbonEmissionsQueryResponse wrapper for the DeleteUsageCarbonEmissionsQuery operation
type DeleteUsageCarbonEmissionsQueryResponse 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 DeleteUsageCarbonEmissionsQueryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteUsageCarbonEmissionsQueryResponse) String() string
Dimension The dimension used for filtering. Availabe dimensions are: "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", and "tenantName". For 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
func (m Dimension) 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
DynamicDateRange The saved dynamic date range (required when the static date range is missing).
type DynamicDateRange struct {
DynamicDateRangeType DynamicDateRangeDynamicDateRangeTypeEnum `mandatory:"true" json:"dynamicDateRangeType"`
}
func (m DynamicDateRange) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DynamicDateRange) String() string
func (m DynamicDateRange) 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
DynamicDateRangeDynamicDateRangeTypeEnum Enum with underlying type: string
type DynamicDateRangeDynamicDateRangeTypeEnum string
Set of constants representing the allowable values for DynamicDateRangeDynamicDateRangeTypeEnum
const (
DynamicDateRangeDynamicDateRangeTypeLast7Days DynamicDateRangeDynamicDateRangeTypeEnum = "LAST_7_DAYS"
DynamicDateRangeDynamicDateRangeTypeLast10Days DynamicDateRangeDynamicDateRangeTypeEnum = "LAST_10_DAYS"
DynamicDateRangeDynamicDateRangeTypeLastCalendarWeek DynamicDateRangeDynamicDateRangeTypeEnum = "LAST_CALENDAR_WEEK"
DynamicDateRangeDynamicDateRangeTypeLastCalendarMonth DynamicDateRangeDynamicDateRangeTypeEnum = "LAST_CALENDAR_MONTH"
DynamicDateRangeDynamicDateRangeTypeLast2CalendarMonths DynamicDateRangeDynamicDateRangeTypeEnum = "LAST_2_CALENDAR_MONTHS"
DynamicDateRangeDynamicDateRangeTypeLast3CalendarMonths DynamicDateRangeDynamicDateRangeTypeEnum = "LAST_3_CALENDAR_MONTHS"
DynamicDateRangeDynamicDateRangeTypeLast6CalendarMonths DynamicDateRangeDynamicDateRangeTypeEnum = "LAST_6_CALENDAR_MONTHS"
DynamicDateRangeDynamicDateRangeTypeLast30Days DynamicDateRangeDynamicDateRangeTypeEnum = "LAST_30_DAYS"
DynamicDateRangeDynamicDateRangeTypeMonthToDate DynamicDateRangeDynamicDateRangeTypeEnum = "MONTH_TO_DATE"
DynamicDateRangeDynamicDateRangeTypeLastYear DynamicDateRangeDynamicDateRangeTypeEnum = "LAST_YEAR"
DynamicDateRangeDynamicDateRangeTypeYearTodate DynamicDateRangeDynamicDateRangeTypeEnum = "YEAR_TODATE"
DynamicDateRangeDynamicDateRangeTypeAll DynamicDateRangeDynamicDateRangeTypeEnum = "ALL"
)
func GetDynamicDateRangeDynamicDateRangeTypeEnumValues() []DynamicDateRangeDynamicDateRangeTypeEnum
GetDynamicDateRangeDynamicDateRangeTypeEnumValues Enumerates the set of values for DynamicDateRangeDynamicDateRangeTypeEnum
func GetMappingDynamicDateRangeDynamicDateRangeTypeEnum(val string) (DynamicDateRangeDynamicDateRangeTypeEnum, bool)
GetMappingDynamicDateRangeDynamicDateRangeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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
func (m Filter) 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
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
func GetMappingFilterOperatorEnum(val string) (FilterOperatorEnum, bool)
GetMappingFilterOperatorEnum performs case Insensitive comparison on enum value and return the desired enum
Forecast Forecast configuration of usage/cost.
type Forecast struct {
// The forecast end time.
TimeForecastEnded *common.SDKTime `mandatory:"true" json:"timeForecastEnded"`
// BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.
ForecastType ForecastForecastTypeEnum `mandatory:"false" json:"forecastType,omitempty"`
// The forecast start time. Defaults to UTC-1 if not specified.
TimeForecastStarted *common.SDKTime `mandatory:"false" json:"timeForecastStarted"`
}
func (m Forecast) String() string
func (m Forecast) 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
ForecastForecastTypeEnum Enum with underlying type: string
type ForecastForecastTypeEnum string
Set of constants representing the allowable values for ForecastForecastTypeEnum
const (
ForecastForecastTypeBasic ForecastForecastTypeEnum = "BASIC"
)
func GetForecastForecastTypeEnumValues() []ForecastForecastTypeEnum
GetForecastForecastTypeEnumValues Enumerates the set of values for ForecastForecastTypeEnum
func GetMappingForecastForecastTypeEnum(val string) (ForecastForecastTypeEnum, bool)
GetMappingForecastForecastTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GetCustomTableRequest wrapper for the GetCustomTable operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/GetCustomTable.go.html to see an example of how to use GetCustomTableRequest.
type GetCustomTableRequest struct {
// The custom table unique OCID.
CustomTableId *string `mandatory:"true" contributesTo:"path" name:"customTableId"`
// 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 GetCustomTableRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCustomTableRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCustomTableRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCustomTableRequest) String() string
func (request GetCustomTableRequest) 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
GetCustomTableResponse wrapper for the GetCustomTable operation
type GetCustomTableResponse struct {
// The underlying http response
RawResponse *http.Response
// The CustomTable instance
CustomTable `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 GetCustomTableResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCustomTableResponse) String() string
GetQueryRequest wrapper for the GetQuery operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/GetQuery.go.html to see an example of how to use GetQueryRequest.
type GetQueryRequest struct {
// The query unique OCID.
QueryId *string `mandatory:"true" contributesTo:"path" name:"queryId"`
// 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 GetQueryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetQueryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetQueryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetQueryRequest) String() string
func (request GetQueryRequest) 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
GetQueryResponse wrapper for the GetQuery operation
type GetQueryResponse struct {
// The underlying http response
RawResponse *http.Response
// The Query instance
Query `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 GetQueryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetQueryResponse) String() string
GetScheduleRequest wrapper for the GetSchedule operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/GetSchedule.go.html to see an example of how to use GetScheduleRequest.
type GetScheduleRequest struct {
// The schedule unique OCID.
ScheduleId *string `mandatory:"true" contributesTo:"path" name:"scheduleId"`
// 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 GetScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetScheduleRequest) String() string
func (request GetScheduleRequest) 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
GetScheduleResponse wrapper for the GetSchedule operation
type GetScheduleResponse struct {
// The underlying http response
RawResponse *http.Response
// The Schedule instance
Schedule `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 GetScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetScheduleResponse) String() string
GetScheduledRunRequest wrapper for the GetScheduledRun operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/GetScheduledRun.go.html to see an example of how to use GetScheduledRunRequest.
type GetScheduledRunRequest struct {
// The scheduledRun unique OCID.
ScheduledRunId *string `mandatory:"true" contributesTo:"path" name:"scheduledRunId"`
// 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 GetScheduledRunRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetScheduledRunRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetScheduledRunRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetScheduledRunRequest) String() string
func (request GetScheduledRunRequest) 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
GetScheduledRunResponse wrapper for the GetScheduledRun operation
type GetScheduledRunResponse struct {
// The underlying http response
RawResponse *http.Response
// The ScheduledRun instance
ScheduledRun `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 GetScheduledRunResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetScheduledRunResponse) String() string
GetUsageCarbonEmissionsQueryRequest wrapper for the GetUsageCarbonEmissionsQuery operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/GetUsageCarbonEmissionsQuery.go.html to see an example of how to use GetUsageCarbonEmissionsQueryRequest.
type GetUsageCarbonEmissionsQueryRequest struct {
// The query unique OCID.
UsageCarbonEmissionsQueryId *string `mandatory:"true" contributesTo:"path" name:"usageCarbonEmissionsQueryId"`
// 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 GetUsageCarbonEmissionsQueryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetUsageCarbonEmissionsQueryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetUsageCarbonEmissionsQueryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetUsageCarbonEmissionsQueryRequest) String() string
func (request GetUsageCarbonEmissionsQueryRequest) 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
GetUsageCarbonEmissionsQueryResponse wrapper for the GetUsageCarbonEmissionsQuery operation
type GetUsageCarbonEmissionsQueryResponse struct {
// The underlying http response
RawResponse *http.Response
// The UsageCarbonEmissionsQuery instance
UsageCarbonEmissionsQuery `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 GetUsageCarbonEmissionsQueryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetUsageCarbonEmissionsQueryResponse) String() string
ListCustomTablesRequest wrapper for the ListCustomTables operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/ListCustomTables.go.html to see an example of how to use ListCustomTablesRequest.
type ListCustomTablesRequest struct {
// The compartment ID in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The saved report ID in which to list resources.
SavedReportId *string `mandatory:"true" contributesTo:"query" name:"savedReportId"`
// 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 maximumimum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 field to sort by. If not specified, the default is displayName.
SortBy ListCustomTablesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListCustomTablesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListCustomTablesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCustomTablesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCustomTablesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCustomTablesRequest) String() string
func (request ListCustomTablesRequest) 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
ListCustomTablesResponse wrapper for the ListCustomTables operation
type ListCustomTablesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of CustomTableCollection instances
CustomTableCollection `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 custom tables. If this header appears in the response, then this
// is a partial list of custom tables. Include this value as the `page` parameter in a subsequent
// GET request, to get the next batch of custom tables.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListCustomTablesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCustomTablesResponse) String() string
ListCustomTablesSortByEnum Enum with underlying type: string
type ListCustomTablesSortByEnum string
Set of constants representing the allowable values for ListCustomTablesSortByEnum
const (
ListCustomTablesSortByDisplayname ListCustomTablesSortByEnum = "displayName"
)
func GetListCustomTablesSortByEnumValues() []ListCustomTablesSortByEnum
GetListCustomTablesSortByEnumValues Enumerates the set of values for ListCustomTablesSortByEnum
func GetMappingListCustomTablesSortByEnum(val string) (ListCustomTablesSortByEnum, bool)
GetMappingListCustomTablesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCustomTablesSortOrderEnum Enum with underlying type: string
type ListCustomTablesSortOrderEnum string
Set of constants representing the allowable values for ListCustomTablesSortOrderEnum
const (
ListCustomTablesSortOrderAsc ListCustomTablesSortOrderEnum = "ASC"
ListCustomTablesSortOrderDesc ListCustomTablesSortOrderEnum = "DESC"
)
func GetListCustomTablesSortOrderEnumValues() []ListCustomTablesSortOrderEnum
GetListCustomTablesSortOrderEnumValues Enumerates the set of values for ListCustomTablesSortOrderEnum
func GetMappingListCustomTablesSortOrderEnum(val string) (ListCustomTablesSortOrderEnum, bool)
GetMappingListCustomTablesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListQueriesRequest wrapper for the ListQueries operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/ListQueries.go.html to see an example of how to use ListQueriesRequest.
type ListQueriesRequest struct {
// The compartment ID in which to list resources.
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 maximumimum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 field to sort by. If not specified, the default is displayName.
SortBy ListQueriesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListQueriesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListQueriesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListQueriesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListQueriesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListQueriesRequest) String() string
func (request ListQueriesRequest) 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
ListQueriesResponse wrapper for the ListQueries operation
type ListQueriesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of QueryCollection instances
QueryCollection `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 Queries. If this header appears in the response, then this
// is a partial list of Queries. Include this value as the `page` parameter in a subsequent
// GET request, to get the next batch of Queries.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListQueriesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListQueriesResponse) String() string
ListQueriesSortByEnum Enum with underlying type: string
type ListQueriesSortByEnum string
Set of constants representing the allowable values for ListQueriesSortByEnum
const (
ListQueriesSortByDisplayname ListQueriesSortByEnum = "displayName"
)
func GetListQueriesSortByEnumValues() []ListQueriesSortByEnum
GetListQueriesSortByEnumValues Enumerates the set of values for ListQueriesSortByEnum
func GetMappingListQueriesSortByEnum(val string) (ListQueriesSortByEnum, bool)
GetMappingListQueriesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListQueriesSortOrderEnum Enum with underlying type: string
type ListQueriesSortOrderEnum string
Set of constants representing the allowable values for ListQueriesSortOrderEnum
const (
ListQueriesSortOrderAsc ListQueriesSortOrderEnum = "ASC"
ListQueriesSortOrderDesc ListQueriesSortOrderEnum = "DESC"
)
func GetListQueriesSortOrderEnumValues() []ListQueriesSortOrderEnum
GetListQueriesSortOrderEnumValues Enumerates the set of values for ListQueriesSortOrderEnum
func GetMappingListQueriesSortOrderEnum(val string) (ListQueriesSortOrderEnum, bool)
GetMappingListQueriesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListScheduledRunsRequest wrapper for the ListScheduledRuns operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/ListScheduledRuns.go.html to see an example of how to use ListScheduledRunsRequest.
type ListScheduledRunsRequest struct {
// The unique ID of a schedule.
ScheduleId *string `mandatory:"true" contributesTo:"query" name:"scheduleId"`
// 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 maximumimum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. If not specified, the default is timeCreated.
SortBy ListScheduledRunsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListScheduledRunsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListScheduledRunsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListScheduledRunsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListScheduledRunsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListScheduledRunsRequest) String() string
func (request ListScheduledRunsRequest) 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
ListScheduledRunsResponse wrapper for the ListScheduledRuns operation
type ListScheduledRunsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ScheduledRunCollection instances
ScheduledRunCollection `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 ListScheduledRunsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListScheduledRunsResponse) String() string
ListScheduledRunsSortByEnum Enum with underlying type: string
type ListScheduledRunsSortByEnum string
Set of constants representing the allowable values for ListScheduledRunsSortByEnum
const (
ListScheduledRunsSortByTimecreated ListScheduledRunsSortByEnum = "timeCreated"
)
func GetListScheduledRunsSortByEnumValues() []ListScheduledRunsSortByEnum
GetListScheduledRunsSortByEnumValues Enumerates the set of values for ListScheduledRunsSortByEnum
func GetMappingListScheduledRunsSortByEnum(val string) (ListScheduledRunsSortByEnum, bool)
GetMappingListScheduledRunsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListScheduledRunsSortOrderEnum Enum with underlying type: string
type ListScheduledRunsSortOrderEnum string
Set of constants representing the allowable values for ListScheduledRunsSortOrderEnum
const (
ListScheduledRunsSortOrderAsc ListScheduledRunsSortOrderEnum = "ASC"
ListScheduledRunsSortOrderDesc ListScheduledRunsSortOrderEnum = "DESC"
)
func GetListScheduledRunsSortOrderEnumValues() []ListScheduledRunsSortOrderEnum
GetListScheduledRunsSortOrderEnumValues Enumerates the set of values for ListScheduledRunsSortOrderEnum
func GetMappingListScheduledRunsSortOrderEnum(val string) (ListScheduledRunsSortOrderEnum, bool)
GetMappingListScheduledRunsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSchedulesRequest wrapper for the ListSchedules operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/ListSchedules.go.html to see an example of how to use ListSchedulesRequest.
type ListSchedulesRequest struct {
// The compartment ID in which to list resources.
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 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 maximumimum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. If not specified, the default is timeCreated.
SortBy ListSchedulesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListSchedulesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Query parameter for filtering by name
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// 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 ListSchedulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSchedulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSchedulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSchedulesRequest) String() string
func (request ListSchedulesRequest) 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
ListSchedulesResponse wrapper for the ListSchedules operation
type ListSchedulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ScheduleCollection instances
ScheduleCollection `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 ListSchedulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSchedulesResponse) String() string
ListSchedulesSortByEnum Enum with underlying type: string
type ListSchedulesSortByEnum string
Set of constants representing the allowable values for ListSchedulesSortByEnum
const (
ListSchedulesSortByName ListSchedulesSortByEnum = "name"
ListSchedulesSortByTimecreated ListSchedulesSortByEnum = "timeCreated"
)
func GetListSchedulesSortByEnumValues() []ListSchedulesSortByEnum
GetListSchedulesSortByEnumValues Enumerates the set of values for ListSchedulesSortByEnum
func GetMappingListSchedulesSortByEnum(val string) (ListSchedulesSortByEnum, bool)
GetMappingListSchedulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSchedulesSortOrderEnum Enum with underlying type: string
type ListSchedulesSortOrderEnum string
Set of constants representing the allowable values for ListSchedulesSortOrderEnum
const (
ListSchedulesSortOrderAsc ListSchedulesSortOrderEnum = "ASC"
ListSchedulesSortOrderDesc ListSchedulesSortOrderEnum = "DESC"
)
func GetListSchedulesSortOrderEnumValues() []ListSchedulesSortOrderEnum
GetListSchedulesSortOrderEnumValues Enumerates the set of values for ListSchedulesSortOrderEnum
func GetMappingListSchedulesSortOrderEnum(val string) (ListSchedulesSortOrderEnum, bool)
GetMappingListSchedulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListUsageCarbonEmissionsQueriesRequest wrapper for the ListUsageCarbonEmissionsQueries operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/ListUsageCarbonEmissionsQueries.go.html to see an example of how to use ListUsageCarbonEmissionsQueriesRequest.
type ListUsageCarbonEmissionsQueriesRequest struct {
// The compartment ID in which to list resources.
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 maximumimum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 field to sort by. If not specified, the default is displayName.
SortBy ListUsageCarbonEmissionsQueriesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListUsageCarbonEmissionsQueriesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListUsageCarbonEmissionsQueriesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListUsageCarbonEmissionsQueriesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListUsageCarbonEmissionsQueriesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListUsageCarbonEmissionsQueriesRequest) String() string
func (request ListUsageCarbonEmissionsQueriesRequest) 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
ListUsageCarbonEmissionsQueriesResponse wrapper for the ListUsageCarbonEmissionsQueries operation
type ListUsageCarbonEmissionsQueriesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of UsageCarbonEmissionsQueryCollection instances
UsageCarbonEmissionsQueryCollection `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 ListUsageCarbonEmissionsQueriesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListUsageCarbonEmissionsQueriesResponse) String() string
ListUsageCarbonEmissionsQueriesSortByEnum Enum with underlying type: string
type ListUsageCarbonEmissionsQueriesSortByEnum string
Set of constants representing the allowable values for ListUsageCarbonEmissionsQueriesSortByEnum
const (
ListUsageCarbonEmissionsQueriesSortByDisplayname ListUsageCarbonEmissionsQueriesSortByEnum = "displayName"
)
func GetListUsageCarbonEmissionsQueriesSortByEnumValues() []ListUsageCarbonEmissionsQueriesSortByEnum
GetListUsageCarbonEmissionsQueriesSortByEnumValues Enumerates the set of values for ListUsageCarbonEmissionsQueriesSortByEnum
func GetMappingListUsageCarbonEmissionsQueriesSortByEnum(val string) (ListUsageCarbonEmissionsQueriesSortByEnum, bool)
GetMappingListUsageCarbonEmissionsQueriesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListUsageCarbonEmissionsQueriesSortOrderEnum Enum with underlying type: string
type ListUsageCarbonEmissionsQueriesSortOrderEnum string
Set of constants representing the allowable values for ListUsageCarbonEmissionsQueriesSortOrderEnum
const (
ListUsageCarbonEmissionsQueriesSortOrderAsc ListUsageCarbonEmissionsQueriesSortOrderEnum = "ASC"
ListUsageCarbonEmissionsQueriesSortOrderDesc ListUsageCarbonEmissionsQueriesSortOrderEnum = "DESC"
)
func GetListUsageCarbonEmissionsQueriesSortOrderEnumValues() []ListUsageCarbonEmissionsQueriesSortOrderEnum
GetListUsageCarbonEmissionsQueriesSortOrderEnumValues Enumerates the set of values for ListUsageCarbonEmissionsQueriesSortOrderEnum
func GetMappingListUsageCarbonEmissionsQueriesSortOrderEnum(val string) (ListUsageCarbonEmissionsQueriesSortOrderEnum, bool)
GetMappingListUsageCarbonEmissionsQueriesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ObjectStorageLocation The object storage location where usage or cost CSVs will be uploaded.
type ObjectStorageLocation struct {
// The destination Object Store Region specified by the customer.
Region *string `mandatory:"true" json:"region"`
// The namespace needed to determine the object storage bucket.
Namespace *string `mandatory:"true" json:"namespace"`
// The bucket name where usage or cost CSVs will be uploaded.
BucketName *string `mandatory:"true" json:"bucketName"`
}
func (m ObjectStorageLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageLocation) String() string
func (m ObjectStorageLocation) 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
Query The query to filter and aggregate.
type Query struct {
// The query OCID.
Id *string `mandatory:"true" json:"id"`
// The compartment OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
QueryDefinition *QueryDefinition `mandatory:"true" json:"queryDefinition"`
}
func (m Query) String() string
func (m Query) 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
QueryCollection A query list.
type QueryCollection struct {
// Query list.
Items []QuerySummary `mandatory:"true" json:"items"`
}
func (m QueryCollection) String() string
func (m QueryCollection) 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
QueryDefinition The common fields for queries.
type QueryDefinition struct {
// The query display name. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
ReportQuery *ReportQuery `mandatory:"true" json:"reportQuery"`
CostAnalysisUI *CostAnalysisUi `mandatory:"true" json:"costAnalysisUI"`
// The saved query version.
Version *float32 `mandatory:"true" json:"version"`
}
func (m QueryDefinition) String() string
func (m QueryDefinition) 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
QueryProperties The query properties.
type QueryProperties struct {
// The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation.
// Allowed values are:
// DAILY
// MONTHLY
Granularity QueryPropertiesGranularityEnum `mandatory:"true" json:"granularity"`
DateRange DateRange `mandatory:"true" json:"dateRange"`
// Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
GroupBy []string `mandatory:"false" json:"groupBy"`
// GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [ { "namespace": "oracle", "key": "createdBy" ]
GroupByTag []Tag `mandatory:"false" json:"groupByTag"`
Filter *Filter `mandatory:"false" json:"filter"`
// The depth level of the compartment.
CompartmentDepth *float32 `mandatory:"false" json:"compartmentDepth"`
// The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data.
// Allowed values are:
// USAGE
// COST
// USAGE_AND_COST
QueryType QueryPropertiesQueryTypeEnum `mandatory:"false" json:"queryType,omitempty"`
// Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.
IsAggregateByTime *bool `mandatory:"false" json:"isAggregateByTime"`
}
func (m QueryProperties) String() string
func (m *QueryProperties) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m QueryProperties) 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
QueryPropertiesGranularityEnum Enum with underlying type: string
type QueryPropertiesGranularityEnum string
Set of constants representing the allowable values for QueryPropertiesGranularityEnum
const (
QueryPropertiesGranularityDaily QueryPropertiesGranularityEnum = "DAILY"
QueryPropertiesGranularityMonthly QueryPropertiesGranularityEnum = "MONTHLY"
)
func GetMappingQueryPropertiesGranularityEnum(val string) (QueryPropertiesGranularityEnum, bool)
GetMappingQueryPropertiesGranularityEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQueryPropertiesGranularityEnumValues() []QueryPropertiesGranularityEnum
GetQueryPropertiesGranularityEnumValues Enumerates the set of values for QueryPropertiesGranularityEnum
QueryPropertiesQueryTypeEnum Enum with underlying type: string
type QueryPropertiesQueryTypeEnum string
Set of constants representing the allowable values for QueryPropertiesQueryTypeEnum
const (
QueryPropertiesQueryTypeUsage QueryPropertiesQueryTypeEnum = "USAGE"
QueryPropertiesQueryTypeCost QueryPropertiesQueryTypeEnum = "COST"
QueryPropertiesQueryTypeUsageAndCost QueryPropertiesQueryTypeEnum = "USAGE_AND_COST"
)
func GetMappingQueryPropertiesQueryTypeEnum(val string) (QueryPropertiesQueryTypeEnum, bool)
GetMappingQueryPropertiesQueryTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQueryPropertiesQueryTypeEnumValues() []QueryPropertiesQueryTypeEnum
GetQueryPropertiesQueryTypeEnumValues Enumerates the set of values for QueryPropertiesQueryTypeEnum
QuerySummary Query summery in the list request.
type QuerySummary struct {
// The query OCID.
Id *string `mandatory:"true" json:"id"`
QueryDefinition *QueryDefinition `mandatory:"true" json:"queryDefinition"`
}
func (m QuerySummary) String() string
func (m QuerySummary) 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
ReportQuery The request of the generated Cost Analysis report.
type ReportQuery struct {
// Tenant ID.
TenantId *string `mandatory:"true" json:"tenantId"`
// The usage granularity.
// HOURLY - Hourly data aggregation.
// DAILY - Daily data aggregation.
// MONTHLY - Monthly data aggregation.
// TOTAL - Not yet supported.
Granularity ReportQueryGranularityEnum `mandatory:"true" json:"granularity"`
// The usage start time.
TimeUsageStarted *common.SDKTime `mandatory:"false" json:"timeUsageStarted"`
// The usage end time.
TimeUsageEnded *common.SDKTime `mandatory:"false" json:"timeUsageEnded"`
// Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.
IsAggregateByTime *bool `mandatory:"false" json:"isAggregateByTime"`
Forecast *Forecast `mandatory:"false" json:"forecast"`
// The query usage type. COST by default if it is missing.
// Usage - Query the usage data.
// Cost - Query the cost/billing data.
// Credit - Query the credit adjustments data.
// ExpiredCredit - Query the expired credits data
// AllCredit - Query the credit adjustments and expired credit
QueryType ReportQueryQueryTypeEnum `mandatory:"false" json:"queryType,omitempty"`
// Aggregate the result by.
// example:
// `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit",
// "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd",
// "resourceId", "tenantId", "tenantName"]`
GroupBy []string `mandatory:"false" json:"groupBy"`
// GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list.
// For example:
// `[{"namespace":"oracle", "key":"createdBy"]`
GroupByTag []Tag `mandatory:"false" json:"groupByTag"`
// The compartment depth level.
CompartmentDepth *float32 `mandatory:"false" json:"compartmentDepth"`
Filter *Filter `mandatory:"false" json:"filter"`
// The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.
DateRangeName ReportQueryDateRangeNameEnum `mandatory:"false" json:"dateRangeName,omitempty"`
}
func (m ReportQuery) String() string
func (m ReportQuery) 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
ReportQueryDateRangeNameEnum Enum with underlying type: string
type ReportQueryDateRangeNameEnum string
Set of constants representing the allowable values for ReportQueryDateRangeNameEnum
const (
ReportQueryDateRangeNameLastSevenDays ReportQueryDateRangeNameEnum = "LAST_SEVEN_DAYS"
ReportQueryDateRangeNameLastTenDays ReportQueryDateRangeNameEnum = "LAST_TEN_DAYS"
ReportQueryDateRangeNameMtd ReportQueryDateRangeNameEnum = "MTD"
ReportQueryDateRangeNameLastTwoMonths ReportQueryDateRangeNameEnum = "LAST_TWO_MONTHS"
ReportQueryDateRangeNameLastThreeMonths ReportQueryDateRangeNameEnum = "LAST_THREE_MONTHS"
ReportQueryDateRangeNameAll ReportQueryDateRangeNameEnum = "ALL"
ReportQueryDateRangeNameLastSixMonths ReportQueryDateRangeNameEnum = "LAST_SIX_MONTHS"
ReportQueryDateRangeNameLastOneYear ReportQueryDateRangeNameEnum = "LAST_ONE_YEAR"
ReportQueryDateRangeNameYtd ReportQueryDateRangeNameEnum = "YTD"
ReportQueryDateRangeNameCustom ReportQueryDateRangeNameEnum = "CUSTOM"
)
func GetMappingReportQueryDateRangeNameEnum(val string) (ReportQueryDateRangeNameEnum, bool)
GetMappingReportQueryDateRangeNameEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReportQueryDateRangeNameEnumValues() []ReportQueryDateRangeNameEnum
GetReportQueryDateRangeNameEnumValues Enumerates the set of values for ReportQueryDateRangeNameEnum
ReportQueryGranularityEnum Enum with underlying type: string
type ReportQueryGranularityEnum string
Set of constants representing the allowable values for ReportQueryGranularityEnum
const (
ReportQueryGranularityHourly ReportQueryGranularityEnum = "HOURLY"
ReportQueryGranularityDaily ReportQueryGranularityEnum = "DAILY"
ReportQueryGranularityMonthly ReportQueryGranularityEnum = "MONTHLY"
ReportQueryGranularityTotal ReportQueryGranularityEnum = "TOTAL"
)
func GetMappingReportQueryGranularityEnum(val string) (ReportQueryGranularityEnum, bool)
GetMappingReportQueryGranularityEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReportQueryGranularityEnumValues() []ReportQueryGranularityEnum
GetReportQueryGranularityEnumValues Enumerates the set of values for ReportQueryGranularityEnum
ReportQueryQueryTypeEnum Enum with underlying type: string
type ReportQueryQueryTypeEnum string
Set of constants representing the allowable values for ReportQueryQueryTypeEnum
const (
ReportQueryQueryTypeUsage ReportQueryQueryTypeEnum = "USAGE"
ReportQueryQueryTypeCost ReportQueryQueryTypeEnum = "COST"
ReportQueryQueryTypeCredit ReportQueryQueryTypeEnum = "CREDIT"
ReportQueryQueryTypeExpiredcredit ReportQueryQueryTypeEnum = "EXPIREDCREDIT"
ReportQueryQueryTypeAllcredit ReportQueryQueryTypeEnum = "ALLCREDIT"
)
func GetMappingReportQueryQueryTypeEnum(val string) (ReportQueryQueryTypeEnum, bool)
GetMappingReportQueryQueryTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReportQueryQueryTypeEnumValues() []ReportQueryQueryTypeEnum
GetReportQueryQueryTypeEnumValues Enumerates the set of values for ReportQueryQueryTypeEnum
RequestAverageCarbonEmissionRequest wrapper for the RequestAverageCarbonEmission operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/RequestAverageCarbonEmission.go.html to see an example of how to use RequestAverageCarbonEmissionRequest.
type RequestAverageCarbonEmissionRequest struct {
// The SKU part number.
SkuPartNumber *string `mandatory:"true" contributesTo:"path" name:"skuPartNumber"`
// 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 RequestAverageCarbonEmissionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestAverageCarbonEmissionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestAverageCarbonEmissionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestAverageCarbonEmissionRequest) String() string
func (request RequestAverageCarbonEmissionRequest) 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
RequestAverageCarbonEmissionResponse wrapper for the RequestAverageCarbonEmission operation
type RequestAverageCarbonEmissionResponse struct {
// The underlying http response
RawResponse *http.Response
// The AverageCarbonEmission instance
AverageCarbonEmission `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 RequestAverageCarbonEmissionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestAverageCarbonEmissionResponse) String() string
RequestCleanEnergyUsageRequest wrapper for the RequestCleanEnergyUsage operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/RequestCleanEnergyUsage.go.html to see an example of how to use RequestCleanEnergyUsageRequest.
type RequestCleanEnergyUsageRequest struct {
// The region.
Region *string `mandatory:"true" contributesTo:"path" name:"region"`
// The availability domain.
Ad *string `mandatory:"false" contributesTo:"query" name:"ad"`
// 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 RequestCleanEnergyUsageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestCleanEnergyUsageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestCleanEnergyUsageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestCleanEnergyUsageRequest) String() string
func (request RequestCleanEnergyUsageRequest) 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
RequestCleanEnergyUsageResponse wrapper for the RequestCleanEnergyUsage operation
type RequestCleanEnergyUsageResponse struct {
// The underlying http response
RawResponse *http.Response
// The CleanEnergyUsage instance
CleanEnergyUsage `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 RequestCleanEnergyUsageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestCleanEnergyUsageResponse) String() string
RequestSummarizedConfigurationsRequest wrapper for the RequestSummarizedConfigurations operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestSummarizedConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request RequestSummarizedConfigurationsRequest) 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
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"`
// Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.
IsAggregateByTime *bool `mandatory:"false" json:"isAggregateByTime"`
Forecast *Forecast `mandatory:"false" json:"forecast"`
// The query usage type. COST by default if it is missing.
// Usage - Query the usage data.
// Cost - Query the cost/billing data.
// Credit - Query the credit adjustments data.
// ExpiredCredit - Query the expired credits data.
// AllCredit - Query the credit adjustments and expired credit.
QueryType RequestSummarizedUsagesDetailsQueryTypeEnum `mandatory:"false" json:"queryType,omitempty"`
// Aggregate the result by.
// example:
// `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit",
// "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd",
// "resourceId", "tenantId", "tenantName"]`
GroupBy []string `mandatory:"false" json:"groupBy"`
// GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list.
// For example:
// `[{"namespace":"oracle", "key":"createdBy"]`
GroupByTag []Tag `mandatory:"false" json:"groupByTag"`
// The compartment depth level.
CompartmentDepth *float32 `mandatory:"false" json:"compartmentDepth"`
Filter *Filter `mandatory:"false" json:"filter"`
}
func (m RequestSummarizedUsagesDetails) String() string
func (m RequestSummarizedUsagesDetails) 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
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 GetMappingRequestSummarizedUsagesDetailsGranularityEnum(val string) (RequestSummarizedUsagesDetailsGranularityEnum, bool)
GetMappingRequestSummarizedUsagesDetailsGranularityEnum performs case Insensitive comparison on enum value and return the desired enum
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"
RequestSummarizedUsagesDetailsQueryTypeCredit RequestSummarizedUsagesDetailsQueryTypeEnum = "CREDIT"
RequestSummarizedUsagesDetailsQueryTypeExpiredcredit RequestSummarizedUsagesDetailsQueryTypeEnum = "EXPIREDCREDIT"
RequestSummarizedUsagesDetailsQueryTypeAllcredit RequestSummarizedUsagesDetailsQueryTypeEnum = "ALLCREDIT"
)
func GetMappingRequestSummarizedUsagesDetailsQueryTypeEnum(val string) (RequestSummarizedUsagesDetailsQueryTypeEnum, bool)
GetMappingRequestSummarizedUsagesDetailsQueryTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRequestSummarizedUsagesDetailsQueryTypeEnumValues() []RequestSummarizedUsagesDetailsQueryTypeEnum
GetRequestSummarizedUsagesDetailsQueryTypeEnumValues Enumerates the set of values for RequestSummarizedUsagesDetailsQueryTypeEnum
RequestSummarizedUsagesRequest wrapper for the RequestSummarizedUsages operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/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 maximumimum 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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestSummarizedUsagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request RequestSummarizedUsagesRequest) 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
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
RequestUsageCarbonEmissionConfigRequest wrapper for the RequestUsageCarbonEmissionConfig operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/RequestUsageCarbonEmissionConfig.go.html to see an example of how to use RequestUsageCarbonEmissionConfigRequest.
type RequestUsageCarbonEmissionConfigRequest 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 RequestUsageCarbonEmissionConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestUsageCarbonEmissionConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestUsageCarbonEmissionConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestUsageCarbonEmissionConfigRequest) String() string
func (request RequestUsageCarbonEmissionConfigRequest) 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
RequestUsageCarbonEmissionConfigResponse wrapper for the RequestUsageCarbonEmissionConfig operation
type RequestUsageCarbonEmissionConfigResponse 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 RequestUsageCarbonEmissionConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestUsageCarbonEmissionConfigResponse) String() string
RequestUsageCarbonEmissionsDetails Details for the '/usageCarbonEmissions' query.
type RequestUsageCarbonEmissionsDetails 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"`
// Specifies whether aggregated by time. If isAggregateByTime is true, all usage carbon emissions over the query time period will be added up.
IsAggregateByTime *bool `mandatory:"false" json:"isAggregateByTime"`
// Aggregate the result by.
// For example:
// `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit",
// "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd",
// "resourceId", "resourceName", "tenantId", "tenantName", "subscriptionId"]`
GroupBy []string `mandatory:"false" json:"groupBy"`
// GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list.
// For example:
// `[{"namespace":"oracle", "key":"createdBy"]`
GroupByTag []Tag `mandatory:"false" json:"groupByTag"`
// The compartment depth level.
CompartmentDepth *int `mandatory:"false" json:"compartmentDepth"`
Filter *Filter `mandatory:"false" json:"filter"`
}
func (m RequestUsageCarbonEmissionsDetails) String() string
func (m RequestUsageCarbonEmissionsDetails) 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
RequestUsageCarbonEmissionsRequest wrapper for the RequestUsageCarbonEmissions operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/RequestUsageCarbonEmissions.go.html to see an example of how to use RequestUsageCarbonEmissionsRequest.
type RequestUsageCarbonEmissionsRequest struct {
// getUsageCarbonEmissionRequest contains query inforamtion.
RequestUsageCarbonEmissionsDetails `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 maximumimum 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 RequestUsageCarbonEmissionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RequestUsageCarbonEmissionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RequestUsageCarbonEmissionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestUsageCarbonEmissionsRequest) String() string
func (request RequestUsageCarbonEmissionsRequest) 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
RequestUsageCarbonEmissionsResponse wrapper for the RequestUsageCarbonEmissions operation
type RequestUsageCarbonEmissionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of UsageCarbonEmissionAggregation instances
UsageCarbonEmissionAggregation `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 RequestUsageCarbonEmissionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RequestUsageCarbonEmissionsResponse) String() string
ResultLocation The location where usage or cost CSVs will be uploaded defined by `locationType`, which corresponds with type-specific characteristics.
type ResultLocation interface {
}
ResultLocationLocationTypeEnum Enum with underlying type: string
type ResultLocationLocationTypeEnum string
Set of constants representing the allowable values for ResultLocationLocationTypeEnum
const (
ResultLocationLocationTypeObjectStorage ResultLocationLocationTypeEnum = "OBJECT_STORAGE"
)
func GetMappingResultLocationLocationTypeEnum(val string) (ResultLocationLocationTypeEnum, bool)
GetMappingResultLocationLocationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResultLocationLocationTypeEnumValues() []ResultLocationLocationTypeEnum
GetResultLocationLocationTypeEnumValues Enumerates the set of values for ResultLocationLocationTypeEnum
SavedCustomTable The custom table for Cost Analysis UI rendering.
type SavedCustomTable struct {
// The name of the custom table.
DisplayName *string `mandatory:"true" json:"displayName"`
// The row groupBy key list.
// example:
// `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit",
// "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd",
// "resourceId", "tenantId", "tenantName"]`
RowGroupBy []string `mandatory:"false" json:"rowGroupBy"`
// The column groupBy key list.
// example:
// `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit",
// "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd",
// "resourceId", "tenantId", "tenantName"]`
ColumnGroupBy []string `mandatory:"false" json:"columnGroupBy"`
// GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported.
// For example:
// `[{"namespace":"oracle", "key":"createdBy"]`
GroupByTag []Tag `mandatory:"false" json:"groupByTag"`
// The compartment depth level.
CompartmentDepth *float32 `mandatory:"false" json:"compartmentDepth"`
// The version of the custom table.
Version *float32 `mandatory:"false" json:"version"`
}
func (m SavedCustomTable) String() string
func (m SavedCustomTable) 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
Schedule The schedule.
type Schedule struct {
// The OCID representing a unique shedule.
Id *string `mandatory:"true" json:"id"`
// The unique name of the schedule created by the user.
Name *string `mandatory:"true" json:"name"`
// The customer tenancy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
ResultLocation ResultLocation `mandatory:"true" json:"resultLocation"`
// Specifies the frequency according to when the schedule will be run,
// in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10 (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10).
// Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
ScheduleRecurrences *string `mandatory:"true" json:"scheduleRecurrences"`
// The date and time of the first time job execution.
TimeScheduled *common.SDKTime `mandatory:"true" json:"timeScheduled"`
// The date and time the schedule was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The schedule lifecycle state.
LifecycleState ScheduleLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The description of the schedule.
Description *string `mandatory:"false" json:"description"`
// The date and time of the next job execution.
TimeNextRun *common.SDKTime `mandatory:"false" json:"timeNextRun"`
// Specifies the supported output file format.
OutputFileFormat ScheduleOutputFileFormatEnum `mandatory:"false" json:"outputFileFormat,omitempty"`
// The saved report ID which can also be used to generate a query.
SavedReportId *string `mandatory:"false" json:"savedReportId"`
QueryProperties *QueryProperties `mandatory:"false" json:"queryProperties"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// See Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Schedule) String() string
func (m *Schedule) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Schedule) 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
ScheduleCollection A schedule collection.
type ScheduleCollection struct {
// Schedule summary list.
Items []ScheduleSummary `mandatory:"true" json:"items"`
}
func (m ScheduleCollection) String() string
func (m ScheduleCollection) 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
ScheduleLifecycleStateEnum Enum with underlying type: string
type ScheduleLifecycleStateEnum string
Set of constants representing the allowable values for ScheduleLifecycleStateEnum
const (
ScheduleLifecycleStateActive ScheduleLifecycleStateEnum = "ACTIVE"
ScheduleLifecycleStateInactive ScheduleLifecycleStateEnum = "INACTIVE"
)
func GetMappingScheduleLifecycleStateEnum(val string) (ScheduleLifecycleStateEnum, bool)
GetMappingScheduleLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleLifecycleStateEnumValues() []ScheduleLifecycleStateEnum
GetScheduleLifecycleStateEnumValues Enumerates the set of values for ScheduleLifecycleStateEnum
ScheduleOutputFileFormatEnum Enum with underlying type: string
type ScheduleOutputFileFormatEnum string
Set of constants representing the allowable values for ScheduleOutputFileFormatEnum
const (
ScheduleOutputFileFormatCsv ScheduleOutputFileFormatEnum = "CSV"
ScheduleOutputFileFormatPdf ScheduleOutputFileFormatEnum = "PDF"
)
func GetMappingScheduleOutputFileFormatEnum(val string) (ScheduleOutputFileFormatEnum, bool)
GetMappingScheduleOutputFileFormatEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleOutputFileFormatEnumValues() []ScheduleOutputFileFormatEnum
GetScheduleOutputFileFormatEnumValues Enumerates the set of values for ScheduleOutputFileFormatEnum
ScheduleSummary Schedule summary for the list schedule.
type ScheduleSummary struct {
// The schedule OCID.
Id *string `mandatory:"true" json:"id"`
// The unique name of the user-created schedule.
Name *string `mandatory:"true" json:"name"`
// Specifies the frequency according to when the schedule will be run,
// in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10 (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10).
// Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
ScheduleRecurrences *string `mandatory:"true" json:"scheduleRecurrences"`
// The date and time of the first time job execution.
TimeScheduled *common.SDKTime `mandatory:"true" json:"timeScheduled"`
// The schedule summary lifecycle state.
LifecycleState ScheduleLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The description of the schedule.
Description *string `mandatory:"false" json:"description"`
// The date and time of the next job execution.
TimeNextRun *common.SDKTime `mandatory:"false" json:"timeNextRun"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// See Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ScheduleSummary) String() string
func (m ScheduleSummary) 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
ScheduledRun The saved schedule run.
type ScheduledRun struct {
// The ocid representing unique shedule run
Id *string `mandatory:"true" json:"id"`
// The ocid representing unique shedule
ScheduleId *string `mandatory:"true" json:"scheduleId"`
// The time when schedule started executing
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when schedule finished executing
TimeFinished *common.SDKTime `mandatory:"true" json:"timeFinished"`
// Specifies if the schedule job was run successfully or not.
LifecycleState ScheduledRunLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Additional details about scheduled run failure
LifecycleDetails *string `mandatory:"true" json:"lifecycleDetails"`
}
func (m ScheduledRun) String() string
func (m ScheduledRun) 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
ScheduledRunCollection The schedule past run list.
type ScheduledRunCollection struct {
// The schedule past run list.
Items []ScheduledRunSummary `mandatory:"true" json:"items"`
}
func (m ScheduledRunCollection) String() string
func (m ScheduledRunCollection) 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
ScheduledRunLifecycleStateEnum Enum with underlying type: string
type ScheduledRunLifecycleStateEnum string
Set of constants representing the allowable values for ScheduledRunLifecycleStateEnum
const (
ScheduledRunLifecycleStateFailed ScheduledRunLifecycleStateEnum = "FAILED"
ScheduledRunLifecycleStateSucceeded ScheduledRunLifecycleStateEnum = "SUCCEEDED"
)
func GetMappingScheduledRunLifecycleStateEnum(val string) (ScheduledRunLifecycleStateEnum, bool)
GetMappingScheduledRunLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduledRunLifecycleStateEnumValues() []ScheduledRunLifecycleStateEnum
GetScheduledRunLifecycleStateEnumValues Enumerates the set of values for ScheduledRunLifecycleStateEnum
ScheduledRunSummary The saved history past run.
type ScheduledRunSummary struct {
// The ocid representing unique shedule run
Id *string `mandatory:"true" json:"id"`
// The ocid representing unique shedule
ScheduleId *string `mandatory:"true" json:"scheduleId"`
// The time when schedule started executing
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when schedule finished executing
TimeFinished *common.SDKTime `mandatory:"true" json:"timeFinished"`
// Specifies if the schedule job was run successfully or not.
LifecycleState ScheduledRunLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Additional details about scheduled run failure
LifecycleDetails *string `mandatory:"true" json:"lifecycleDetails"`
}
func (m ScheduledRunSummary) String() string
func (m ScheduledRunSummary) 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
StaticDateRange The saved static date range (required when the dynamic date range is missing).
type StaticDateRange struct {
// The usage start time.
TimeUsageStarted *common.SDKTime `mandatory:"true" json:"timeUsageStarted"`
// The usage end time.
TimeUsageEnded *common.SDKTime `mandatory:"true" json:"timeUsageEnded"`
}
func (m StaticDateRange) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StaticDateRange) String() string
func (m StaticDateRange) 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
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
func (m Tag) 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
UpdateCustomTableDetails Details for updating the custom table.
type UpdateCustomTableDetails struct {
SavedCustomTable *SavedCustomTable `mandatory:"true" json:"savedCustomTable"`
}
func (m UpdateCustomTableDetails) String() string
func (m UpdateCustomTableDetails) 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
UpdateCustomTableRequest wrapper for the UpdateCustomTable operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/UpdateCustomTable.go.html to see an example of how to use UpdateCustomTableRequest.
type UpdateCustomTableRequest struct {
// The information to be updated.
UpdateCustomTableDetails `contributesTo:"body"`
// The custom table unique OCID.
CustomTableId *string `mandatory:"true" contributesTo:"path" name:"customTableId"`
// 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 will be 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 UpdateCustomTableRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCustomTableRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCustomTableRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCustomTableRequest) String() string
func (request UpdateCustomTableRequest) 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
UpdateCustomTableResponse wrapper for the UpdateCustomTable operation
type UpdateCustomTableResponse struct {
// The underlying http response
RawResponse *http.Response
// The CustomTable instance
CustomTable `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 UpdateCustomTableResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCustomTableResponse) String() string
UpdateQueryDetails Details for the query to update reportQuery, costAnalysisUI, and displayName.
type UpdateQueryDetails struct {
QueryDefinition *QueryDefinition `mandatory:"true" json:"queryDefinition"`
}
func (m UpdateQueryDetails) String() string
func (m UpdateQueryDetails) 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
UpdateQueryRequest wrapper for the UpdateQuery operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/UpdateQuery.go.html to see an example of how to use UpdateQueryRequest.
type UpdateQueryRequest struct {
// The information to be updated.
UpdateQueryDetails `contributesTo:"body"`
// The query unique OCID.
QueryId *string `mandatory:"true" contributesTo:"path" name:"queryId"`
// 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 will be 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 UpdateQueryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateQueryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateQueryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateQueryRequest) String() string
func (request UpdateQueryRequest) 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
UpdateQueryResponse wrapper for the UpdateQuery operation
type UpdateQueryResponse struct {
// The underlying http response
RawResponse *http.Response
// The Query instance
Query `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 UpdateQueryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateQueryResponse) String() string
UpdateScheduleDetails Details for updating the custom table.
type UpdateScheduleDetails struct {
// The description of the schedule.
Description *string `mandatory:"false" json:"description"`
// Specifies the supported output file format.
OutputFileFormat UpdateScheduleDetailsOutputFileFormatEnum `mandatory:"false" json:"outputFileFormat,omitempty"`
ResultLocation ResultLocation `mandatory:"false" json:"resultLocation"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// See Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateScheduleDetails) String() string
func (m *UpdateScheduleDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateScheduleDetails) 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
UpdateScheduleDetailsOutputFileFormatEnum Enum with underlying type: string
type UpdateScheduleDetailsOutputFileFormatEnum string
Set of constants representing the allowable values for UpdateScheduleDetailsOutputFileFormatEnum
const (
UpdateScheduleDetailsOutputFileFormatCsv UpdateScheduleDetailsOutputFileFormatEnum = "CSV"
UpdateScheduleDetailsOutputFileFormatPdf UpdateScheduleDetailsOutputFileFormatEnum = "PDF"
)
func GetMappingUpdateScheduleDetailsOutputFileFormatEnum(val string) (UpdateScheduleDetailsOutputFileFormatEnum, bool)
GetMappingUpdateScheduleDetailsOutputFileFormatEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateScheduleDetailsOutputFileFormatEnumValues() []UpdateScheduleDetailsOutputFileFormatEnum
GetUpdateScheduleDetailsOutputFileFormatEnumValues Enumerates the set of values for UpdateScheduleDetailsOutputFileFormatEnum
UpdateScheduleRequest wrapper for the UpdateSchedule operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/UpdateSchedule.go.html to see an example of how to use UpdateScheduleRequest.
type UpdateScheduleRequest struct {
// The information to be updated. Currently supports only tags
UpdateScheduleDetails `contributesTo:"body"`
// The schedule unique OCID.
ScheduleId *string `mandatory:"true" contributesTo:"path" name:"scheduleId"`
// 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 will be 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 UpdateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateScheduleRequest) String() string
func (request UpdateScheduleRequest) 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
UpdateScheduleResponse wrapper for the UpdateSchedule operation
type UpdateScheduleResponse struct {
// The underlying http response
RawResponse *http.Response
// The Schedule instance
Schedule `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 UpdateScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateScheduleResponse) String() string
UpdateUsageCarbonEmissionsQueryDetails Details for the query to update usageCarbonEmissionsQuery, costAnalysisUI, and displayName.
type UpdateUsageCarbonEmissionsQueryDetails struct {
QueryDefinition *UsageCarbonEmissionsQueryDefinition `mandatory:"true" json:"queryDefinition"`
}
func (m UpdateUsageCarbonEmissionsQueryDetails) String() string
func (m UpdateUsageCarbonEmissionsQueryDetails) 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
UpdateUsageCarbonEmissionsQueryRequest wrapper for the UpdateUsageCarbonEmissionsQuery operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/UpdateUsageCarbonEmissionsQuery.go.html to see an example of how to use UpdateUsageCarbonEmissionsQueryRequest.
type UpdateUsageCarbonEmissionsQueryRequest struct {
// The information to be updated.
UpdateUsageCarbonEmissionsQueryDetails `contributesTo:"body"`
// The query unique OCID.
UsageCarbonEmissionsQueryId *string `mandatory:"true" contributesTo:"path" name:"usageCarbonEmissionsQueryId"`
// 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 will be 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 UpdateUsageCarbonEmissionsQueryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateUsageCarbonEmissionsQueryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateUsageCarbonEmissionsQueryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateUsageCarbonEmissionsQueryRequest) String() string
func (request UpdateUsageCarbonEmissionsQueryRequest) 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
UpdateUsageCarbonEmissionsQueryResponse wrapper for the UpdateUsageCarbonEmissionsQuery operation
type UpdateUsageCarbonEmissionsQueryResponse struct {
// The underlying http response
RawResponse *http.Response
// The UsageCarbonEmissionsQuery instance
UsageCarbonEmissionsQuery `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 UpdateUsageCarbonEmissionsQueryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateUsageCarbonEmissionsQueryResponse) 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
func (m UsageAggregation) 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
UsageCarbonEmissionAggregation The account (tenant) usage carbon emissions.
type UsageCarbonEmissionAggregation struct {
// A list of usage carbon emission items.
Items []UsageCarbonEmissionSummary `mandatory:"true" json:"items"`
// Aggregate the result by.
GroupBy []string `mandatory:"false" json:"groupBy"`
}
func (m UsageCarbonEmissionAggregation) String() string
func (m UsageCarbonEmissionAggregation) 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
UsageCarbonEmissionSummary The usage carbon emission store result.
type UsageCarbonEmissionSummary struct {
// The usage start time.
TimeUsageStarted *common.SDKTime `mandatory:"true" json:"timeUsageStarted"`
// The usage end time.
TimeUsageEnded *common.SDKTime `mandatory:"true" json:"timeUsageEnded"`
// The carbon emission in MTCO2 unit.
ComputedCarbonEmission *float64 `mandatory:"true" json:"computedCarbonEmission"`
// The method used to calculate carbon emission.
EmissionCalculationMethod *string `mandatory:"true" json:"emissionCalculationMethod"`
// 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 SKU part number.
SkuPartNumber *string `mandatory:"false" json:"skuPartNumber"`
// The SKU friendly name.
SkuName *string `mandatory:"false" json:"skuName"`
// Platform for the cost.
Platform *string `mandatory:"false" json:"platform"`
// The subscription ID.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// For grouping, a tag definition. For filtering, a definition and key.
Tags []Tag `mandatory:"false" json:"tags"`
}
func (m UsageCarbonEmissionSummary) String() string
func (m UsageCarbonEmissionSummary) 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
UsageCarbonEmissionsQuery The usage carbon emissions saved query to filter and aggregate.
type UsageCarbonEmissionsQuery struct {
// The query OCID.
Id *string `mandatory:"true" json:"id"`
// The compartment OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
QueryDefinition *UsageCarbonEmissionsQueryDefinition `mandatory:"true" json:"queryDefinition"`
}
func (m UsageCarbonEmissionsQuery) String() string
func (m UsageCarbonEmissionsQuery) 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
UsageCarbonEmissionsQueryCollection A usage carbon emissions query list.
type UsageCarbonEmissionsQueryCollection struct {
// Usage carbon emissions query list.
Items []UsageCarbonEmissionsQuerySummary `mandatory:"true" json:"items"`
}
func (m UsageCarbonEmissionsQueryCollection) String() string
func (m UsageCarbonEmissionsQueryCollection) 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
UsageCarbonEmissionsQueryDefinition The common fields for queries.
type UsageCarbonEmissionsQueryDefinition struct {
// The query display name. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
ReportQuery *UsageCarbonEmissionsReportQuery `mandatory:"true" json:"reportQuery"`
CostAnalysisUI *CostAnalysisUi `mandatory:"true" json:"costAnalysisUI"`
// The saved query version.
Version *int `mandatory:"true" json:"version"`
}
func (m UsageCarbonEmissionsQueryDefinition) String() string
func (m UsageCarbonEmissionsQueryDefinition) 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
UsageCarbonEmissionsQuerySummary Usage carbon emissions query summary in the list request.
type UsageCarbonEmissionsQuerySummary struct {
// The query OCID.
Id *string `mandatory:"true" json:"id"`
QueryDefinition *UsageCarbonEmissionsQueryDefinition `mandatory:"true" json:"queryDefinition"`
}
func (m UsageCarbonEmissionsQuerySummary) String() string
func (m UsageCarbonEmissionsQuerySummary) 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
UsageCarbonEmissionsReportQuery The request of the generated usage carbon emissions report.
type UsageCarbonEmissionsReportQuery struct {
// Tenant ID.
TenantId *string `mandatory:"true" json:"tenantId"`
// The usage start time.
TimeUsageStarted *common.SDKTime `mandatory:"false" json:"timeUsageStarted"`
// The usage end time.
TimeUsageEnded *common.SDKTime `mandatory:"false" json:"timeUsageEnded"`
// Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.
IsAggregateByTime *bool `mandatory:"false" json:"isAggregateByTime"`
// Specifies what to aggregate the result by.
// For example:
// `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit",
// "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd",
// "resourceId", "tenantId", "tenantName"]`
GroupBy []string `mandatory:"false" json:"groupBy"`
// GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list.
// For example:
// `[{"namespace":"oracle", "key":"createdBy"]`
GroupByTag []Tag `mandatory:"false" json:"groupByTag"`
// The compartment depth level.
CompartmentDepth *int `mandatory:"false" json:"compartmentDepth"`
Filter *Filter `mandatory:"false" json:"filter"`
// The UI date range, for example, LAST_THREE_MONTHS. It will override timeUsageStarted and timeUsageEnded properties.
DateRangeName UsageCarbonEmissionsReportQueryDateRangeNameEnum `mandatory:"false" json:"dateRangeName,omitempty"`
}
func (m UsageCarbonEmissionsReportQuery) String() string
func (m UsageCarbonEmissionsReportQuery) 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
UsageCarbonEmissionsReportQueryDateRangeNameEnum Enum with underlying type: string
type UsageCarbonEmissionsReportQueryDateRangeNameEnum string
Set of constants representing the allowable values for UsageCarbonEmissionsReportQueryDateRangeNameEnum
const (
UsageCarbonEmissionsReportQueryDateRangeNameLastTwoMonths UsageCarbonEmissionsReportQueryDateRangeNameEnum = "LAST_TWO_MONTHS"
UsageCarbonEmissionsReportQueryDateRangeNameLastThreeMonths UsageCarbonEmissionsReportQueryDateRangeNameEnum = "LAST_THREE_MONTHS"
UsageCarbonEmissionsReportQueryDateRangeNameLastSixMonths UsageCarbonEmissionsReportQueryDateRangeNameEnum = "LAST_SIX_MONTHS"
UsageCarbonEmissionsReportQueryDateRangeNameLastOneYear UsageCarbonEmissionsReportQueryDateRangeNameEnum = "LAST_ONE_YEAR"
UsageCarbonEmissionsReportQueryDateRangeNameCustom UsageCarbonEmissionsReportQueryDateRangeNameEnum = "CUSTOM"
)
func GetMappingUsageCarbonEmissionsReportQueryDateRangeNameEnum(val string) (UsageCarbonEmissionsReportQueryDateRangeNameEnum, bool)
GetMappingUsageCarbonEmissionsReportQueryDateRangeNameEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUsageCarbonEmissionsReportQueryDateRangeNameEnumValues() []UsageCarbonEmissionsReportQueryDateRangeNameEnum
GetUsageCarbonEmissionsReportQueryDateRangeNameEnumValues Enumerates the set of values for UsageCarbonEmissionsReportQueryDateRangeNameEnum
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"`
// The forecasted data.
IsForecast *bool `mandatory:"false" json:"isForecast"`
// For grouping, a tag definition. For filtering, a definition and key.
Tags []Tag `mandatory:"false" json:"tags"`
}
func (m UsageSummary) String() string
func (m UsageSummary) 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
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) CreateCustomTable(ctx context.Context, request CreateCustomTableRequest) (response CreateCustomTableResponse, err error)
CreateCustomTable Returns the created custom table.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/CreateCustomTable.go.html to see an example of how to use CreateCustomTable API.
func (client UsageapiClient) CreateQuery(ctx context.Context, request CreateQueryRequest) (response CreateQueryResponse, err error)
CreateQuery Returns the created query.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/CreateQuery.go.html to see an example of how to use CreateQuery API.
func (client UsageapiClient) CreateSchedule(ctx context.Context, request CreateScheduleRequest) (response CreateScheduleResponse, err error)
CreateSchedule Returns the created schedule.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/CreateSchedule.go.html to see an example of how to use CreateSchedule API.
func (client UsageapiClient) CreateUsageCarbonEmissionsQuery(ctx context.Context, request CreateUsageCarbonEmissionsQueryRequest) (response CreateUsageCarbonEmissionsQueryResponse, err error)
CreateUsageCarbonEmissionsQuery Returns the created usage carbon emissions query.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/CreateUsageCarbonEmissionsQuery.go.html to see an example of how to use CreateUsageCarbonEmissionsQuery API.
func (client UsageapiClient) DeleteCustomTable(ctx context.Context, request DeleteCustomTableRequest) (response DeleteCustomTableResponse, err error)
DeleteCustomTable Delete a saved custom table by the OCID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/DeleteCustomTable.go.html to see an example of how to use DeleteCustomTable API.
func (client UsageapiClient) DeleteQuery(ctx context.Context, request DeleteQueryRequest) (response DeleteQueryResponse, err error)
DeleteQuery Delete a saved query by the OCID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/DeleteQuery.go.html to see an example of how to use DeleteQuery API.
func (client UsageapiClient) DeleteSchedule(ctx context.Context, request DeleteScheduleRequest) (response DeleteScheduleResponse, err error)
DeleteSchedule Delete a saved scheduled report by the OCID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/DeleteSchedule.go.html to see an example of how to use DeleteSchedule API.
func (client UsageapiClient) DeleteUsageCarbonEmissionsQuery(ctx context.Context, request DeleteUsageCarbonEmissionsQueryRequest) (response DeleteUsageCarbonEmissionsQueryResponse, err error)
DeleteUsageCarbonEmissionsQuery Delete a usage carbon emissions saved query by the OCID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/DeleteUsageCarbonEmissionsQuery.go.html to see an example of how to use DeleteUsageCarbonEmissionsQuery API.
func (client UsageapiClient) GetCustomTable(ctx context.Context, request GetCustomTableRequest) (response GetCustomTableResponse, err error)
GetCustomTable Returns the saved custom table.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/GetCustomTable.go.html to see an example of how to use GetCustomTable API.
func (client UsageapiClient) GetQuery(ctx context.Context, request GetQueryRequest) (response GetQueryResponse, err error)
GetQuery Returns the saved query.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/GetQuery.go.html to see an example of how to use GetQuery API.
func (client UsageapiClient) GetSchedule(ctx context.Context, request GetScheduleRequest) (response GetScheduleResponse, err error)
GetSchedule Returns the saved schedule.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/GetSchedule.go.html to see an example of how to use GetSchedule API.
func (client UsageapiClient) GetScheduledRun(ctx context.Context, request GetScheduledRunRequest) (response GetScheduledRunResponse, err error)
GetScheduledRun Returns the saved schedule run.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/GetScheduledRun.go.html to see an example of how to use GetScheduledRun API.
func (client UsageapiClient) GetUsageCarbonEmissionsQuery(ctx context.Context, request GetUsageCarbonEmissionsQueryRequest) (response GetUsageCarbonEmissionsQueryResponse, err error)
GetUsageCarbonEmissionsQuery Returns the usage carbon emissions saved query.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/GetUsageCarbonEmissionsQuery.go.html to see an example of how to use GetUsageCarbonEmissionsQuery API.
func (client UsageapiClient) ListCustomTables(ctx context.Context, request ListCustomTablesRequest) (response ListCustomTablesResponse, err error)
ListCustomTables Returns the saved custom table list.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/ListCustomTables.go.html to see an example of how to use ListCustomTables API.
func (client UsageapiClient) ListQueries(ctx context.Context, request ListQueriesRequest) (response ListQueriesResponse, err error)
ListQueries Returns the saved query list.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/ListQueries.go.html to see an example of how to use ListQueries API.
func (client UsageapiClient) ListScheduledRuns(ctx context.Context, request ListScheduledRunsRequest) (response ListScheduledRunsResponse, err error)
ListScheduledRuns Returns schedule history list.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/ListScheduledRuns.go.html to see an example of how to use ListScheduledRuns API.
func (client UsageapiClient) ListSchedules(ctx context.Context, request ListSchedulesRequest) (response ListSchedulesResponse, err error)
ListSchedules Returns the saved schedule list.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/ListSchedules.go.html to see an example of how to use ListSchedules API.
func (client UsageapiClient) ListUsageCarbonEmissionsQueries(ctx context.Context, request ListUsageCarbonEmissionsQueriesRequest) (response ListUsageCarbonEmissionsQueriesResponse, err error)
ListUsageCarbonEmissionsQueries Returns the usage carbon emissions saved query list.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/ListUsageCarbonEmissionsQueries.go.html to see an example of how to use ListUsageCarbonEmissionsQueries API.
func (client UsageapiClient) RequestAverageCarbonEmission(ctx context.Context, request RequestAverageCarbonEmissionRequest) (response RequestAverageCarbonEmissionResponse, err error)
RequestAverageCarbonEmission Returns the average carbon emissions summary by SKU.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/RequestAverageCarbonEmission.go.html to see an example of how to use RequestAverageCarbonEmission API.
func (client UsageapiClient) RequestCleanEnergyUsage(ctx context.Context, request RequestCleanEnergyUsageRequest) (response RequestCleanEnergyUsageResponse, err error)
RequestCleanEnergyUsage Returns the clean energy usage summary by region.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/RequestCleanEnergyUsage.go.html to see an example of how to use RequestCleanEnergyUsage API.
func (client UsageapiClient) RequestSummarizedConfigurations(ctx context.Context, request RequestSummarizedConfigurationsRequest) (response RequestSummarizedConfigurationsResponse, err error)
RequestSummarizedConfigurations Returns the configurations list for the UI drop-down list.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/RequestSummarizedUsages.go.html to see an example of how to use RequestSummarizedUsages API.
func (client UsageapiClient) RequestUsageCarbonEmissionConfig(ctx context.Context, request RequestUsageCarbonEmissionConfigRequest) (response RequestUsageCarbonEmissionConfigResponse, err error)
RequestUsageCarbonEmissionConfig Returns the configuration list for the UI drop-down list of carbon emission console.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/RequestUsageCarbonEmissionConfig.go.html to see an example of how to use RequestUsageCarbonEmissionConfig API.
func (client UsageapiClient) RequestUsageCarbonEmissions(ctx context.Context, request RequestUsageCarbonEmissionsRequest) (response RequestUsageCarbonEmissionsResponse, err error)
RequestUsageCarbonEmissions Returns usage carbon emission for the given account.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/RequestUsageCarbonEmissions.go.html to see an example of how to use RequestUsageCarbonEmissions API.
func (client *UsageapiClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client UsageapiClient) UpdateCustomTable(ctx context.Context, request UpdateCustomTableRequest) (response UpdateCustomTableResponse, err error)
UpdateCustomTable Update a saved custom table by table id.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/UpdateCustomTable.go.html to see an example of how to use UpdateCustomTable API.
func (client UsageapiClient) UpdateQuery(ctx context.Context, request UpdateQueryRequest) (response UpdateQueryResponse, err error)
UpdateQuery Update a saved query by the OCID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/UpdateQuery.go.html to see an example of how to use UpdateQuery API.
func (client UsageapiClient) UpdateSchedule(ctx context.Context, request UpdateScheduleRequest) (response UpdateScheduleResponse, err error)
UpdateSchedule Update a saved schedule
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/UpdateSchedule.go.html to see an example of how to use UpdateSchedule API.
func (client UsageapiClient) UpdateUsageCarbonEmissionsQuery(ctx context.Context, request UpdateUsageCarbonEmissionsQueryRequest) (response UpdateUsageCarbonEmissionsQueryResponse, err error)
UpdateUsageCarbonEmissionsQuery Update a usage carbon emissions saved query by the OCID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/usageapi/UpdateUsageCarbonEmissionsQuery.go.html to see an example of how to use UpdateUsageCarbonEmissionsQuery API.