usageapi

package
v65.69.3 Latest Latest
Warning

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

 Go to latest Published: Jul 23, 2024 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetCostAnalysisUiGraphEnumStringValues 

func GetCostAnalysisUiGraphEnumStringValues() []string

GetCostAnalysisUiGraphEnumStringValues Enumerates the set of values in String for CostAnalysisUiGraphEnum

func GetCreateScheduleDetailsOutputFileFormatEnumStringValues added in v65.21.0 

func GetCreateScheduleDetailsOutputFileFormatEnumStringValues() []string

GetCreateScheduleDetailsOutputFileFormatEnumStringValues Enumerates the set of values in String for CreateScheduleDetailsOutputFileFormatEnum

func GetDateRangeDateRangeTypeEnumStringValues added in v65.3.0 

func GetDateRangeDateRangeTypeEnumStringValues() []string

GetDateRangeDateRangeTypeEnumStringValues Enumerates the set of values in String for DateRangeDateRangeTypeEnum

func GetDynamicDateRangeDynamicDateRangeTypeEnumStringValues added in v65.3.0 

func GetDynamicDateRangeDynamicDateRangeTypeEnumStringValues() []string

GetDynamicDateRangeDynamicDateRangeTypeEnumStringValues Enumerates the set of values in String for DynamicDateRangeDynamicDateRangeTypeEnum

func GetEmailRecipientLifecycleStateEnumStringValues added in v65.63.2 

func GetEmailRecipientLifecycleStateEnumStringValues() []string

GetEmailRecipientLifecycleStateEnumStringValues Enumerates the set of values in String for EmailRecipientLifecycleStateEnum

func GetEmailRecipientsGroupLifecycleStateEnumStringValues added in v65.63.2 

func GetEmailRecipientsGroupLifecycleStateEnumStringValues() []string

GetEmailRecipientsGroupLifecycleStateEnumStringValues Enumerates the set of values in String for EmailRecipientsGroupLifecycleStateEnum

func GetFilterOperatorEnumStringValues 

func GetFilterOperatorEnumStringValues() []string

GetFilterOperatorEnumStringValues Enumerates the set of values in String for FilterOperatorEnum

func GetForecastForecastTypeEnumStringValues 

func GetForecastForecastTypeEnumStringValues() []string

GetForecastForecastTypeEnumStringValues Enumerates the set of values in String for ForecastForecastTypeEnum

func GetListCustomTablesSortByEnumStringValues 

func GetListCustomTablesSortByEnumStringValues() []string

GetListCustomTablesSortByEnumStringValues Enumerates the set of values in String for ListCustomTablesSortByEnum

func GetListCustomTablesSortOrderEnumStringValues 

func GetListCustomTablesSortOrderEnumStringValues() []string

GetListCustomTablesSortOrderEnumStringValues Enumerates the set of values in String for ListCustomTablesSortOrderEnum

func GetListEmailRecipientsGroupsSortByEnumStringValues added in v65.63.2 

func GetListEmailRecipientsGroupsSortByEnumStringValues() []string

GetListEmailRecipientsGroupsSortByEnumStringValues Enumerates the set of values in String for ListEmailRecipientsGroupsSortByEnum

func GetListEmailRecipientsGroupsSortOrderEnumStringValues added in v65.63.2 

func GetListEmailRecipientsGroupsSortOrderEnumStringValues() []string

GetListEmailRecipientsGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListEmailRecipientsGroupsSortOrderEnum

func GetListQueriesSortByEnumStringValues 

func GetListQueriesSortByEnumStringValues() []string

GetListQueriesSortByEnumStringValues Enumerates the set of values in String for ListQueriesSortByEnum

func GetListQueriesSortOrderEnumStringValues 

func GetListQueriesSortOrderEnumStringValues() []string

GetListQueriesSortOrderEnumStringValues Enumerates the set of values in String for ListQueriesSortOrderEnum

func GetListScheduledRunsSortByEnumStringValues added in v65.3.0 

func GetListScheduledRunsSortByEnumStringValues() []string

GetListScheduledRunsSortByEnumStringValues Enumerates the set of values in String for ListScheduledRunsSortByEnum

func GetListScheduledRunsSortOrderEnumStringValues added in v65.3.0 

func GetListScheduledRunsSortOrderEnumStringValues() []string

GetListScheduledRunsSortOrderEnumStringValues Enumerates the set of values in String for ListScheduledRunsSortOrderEnum

func GetListSchedulesSortByEnumStringValues added in v65.3.0 

func GetListSchedulesSortByEnumStringValues() []string

GetListSchedulesSortByEnumStringValues Enumerates the set of values in String for ListSchedulesSortByEnum

func GetListSchedulesSortOrderEnumStringValues added in v65.3.0 

func GetListSchedulesSortOrderEnumStringValues() []string

GetListSchedulesSortOrderEnumStringValues Enumerates the set of values in String for ListSchedulesSortOrderEnum

func GetListUsageCarbonEmissionsQueriesSortByEnumStringValues added in v65.55.0 

func GetListUsageCarbonEmissionsQueriesSortByEnumStringValues() []string

GetListUsageCarbonEmissionsQueriesSortByEnumStringValues Enumerates the set of values in String for ListUsageCarbonEmissionsQueriesSortByEnum

func GetListUsageCarbonEmissionsQueriesSortOrderEnumStringValues added in v65.55.0 

func GetListUsageCarbonEmissionsQueriesSortOrderEnumStringValues() []string

GetListUsageCarbonEmissionsQueriesSortOrderEnumStringValues Enumerates the set of values in String for ListUsageCarbonEmissionsQueriesSortOrderEnum

func GetQueryPropertiesGranularityEnumStringValues added in v65.3.0 

func GetQueryPropertiesGranularityEnumStringValues() []string

GetQueryPropertiesGranularityEnumStringValues Enumerates the set of values in String for QueryPropertiesGranularityEnum

func GetQueryPropertiesQueryTypeEnumStringValues added in v65.3.0 

func GetQueryPropertiesQueryTypeEnumStringValues() []string

GetQueryPropertiesQueryTypeEnumStringValues Enumerates the set of values in String for QueryPropertiesQueryTypeEnum

func GetReportQueryDateRangeNameEnumStringValues 

func GetReportQueryDateRangeNameEnumStringValues() []string

GetReportQueryDateRangeNameEnumStringValues Enumerates the set of values in String for ReportQueryDateRangeNameEnum

func GetReportQueryGranularityEnumStringValues 

func GetReportQueryGranularityEnumStringValues() []string

GetReportQueryGranularityEnumStringValues Enumerates the set of values in String for ReportQueryGranularityEnum

func GetReportQueryQueryTypeEnumStringValues 

func GetReportQueryQueryTypeEnumStringValues() []string

GetReportQueryQueryTypeEnumStringValues Enumerates the set of values in String for ReportQueryQueryTypeEnum

func GetRequestSummarizedUsagesDetailsGranularityEnumStringValues 

func GetRequestSummarizedUsagesDetailsGranularityEnumStringValues() []string

GetRequestSummarizedUsagesDetailsGranularityEnumStringValues Enumerates the set of values in String for RequestSummarizedUsagesDetailsGranularityEnum

func GetRequestSummarizedUsagesDetailsQueryTypeEnumStringValues 

func GetRequestSummarizedUsagesDetailsQueryTypeEnumStringValues() []string

GetRequestSummarizedUsagesDetailsQueryTypeEnumStringValues Enumerates the set of values in String for RequestSummarizedUsagesDetailsQueryTypeEnum

func GetResultLocationLocationTypeEnumStringValues added in v65.3.0 

func GetResultLocationLocationTypeEnumStringValues() []string

GetResultLocationLocationTypeEnumStringValues Enumerates the set of values in String for ResultLocationLocationTypeEnum

func GetScheduleLifecycleStateEnumStringValues added in v65.3.0 

func GetScheduleLifecycleStateEnumStringValues() []string

GetScheduleLifecycleStateEnumStringValues Enumerates the set of values in String for ScheduleLifecycleStateEnum

func GetScheduleOutputFileFormatEnumStringValues added in v65.21.0 

func GetScheduleOutputFileFormatEnumStringValues() []string

GetScheduleOutputFileFormatEnumStringValues Enumerates the set of values in String for ScheduleOutputFileFormatEnum

func GetScheduledRunLifecycleStateEnumStringValues added in v65.3.0 

func GetScheduledRunLifecycleStateEnumStringValues() []string

GetScheduledRunLifecycleStateEnumStringValues Enumerates the set of values in String for ScheduledRunLifecycleStateEnum

func GetUpdateScheduleDetailsOutputFileFormatEnumStringValues added in v65.21.0 

func GetUpdateScheduleDetailsOutputFileFormatEnumStringValues() []string

GetUpdateScheduleDetailsOutputFileFormatEnumStringValues Enumerates the set of values in String for UpdateScheduleDetailsOutputFileFormatEnum

func GetUsageCarbonEmissionsReportQueryDateRangeNameEnumStringValues added in v65.55.0 

func GetUsageCarbonEmissionsReportQueryDateRangeNameEnumStringValues() []string

GetUsageCarbonEmissionsReportQueryDateRangeNameEnumStringValues Enumerates the set of values in String for UsageCarbonEmissionsReportQueryDateRangeNameEnum

Types

type AverageCarbonEmission added in v65.55.0 

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

AverageCarbonEmission Average carbon emission.

func (AverageCarbonEmission) String added in v65.55.0 

func (m AverageCarbonEmission) String() string

func (AverageCarbonEmission) ValidateEnumValue added in v65.55.0 

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

type CleanEnergyUsage added in v65.55.0 

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

CleanEnergyUsage Clean energy usage.

func (CleanEnergyUsage) String added in v65.55.0 

func (m CleanEnergyUsage) String() string

func (CleanEnergyUsage) ValidateEnumValue added in v65.55.0 

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

type Configuration 

type Configuration struct {

	// The configuration key.
	Key *string `mandatory:"true" json:"key"`

	// The configuration value.
	Values []string `mandatory:"false" json:"values"`
}

Configuration A configuration.

func (Configuration) String 

func (m Configuration) String() string

func (Configuration) ValidateEnumValue 

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

type ConfigurationAggregation 

type ConfigurationAggregation struct {

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

ConfigurationAggregation The available configurations.

func (ConfigurationAggregation) String 

func (m ConfigurationAggregation) String() string

func (ConfigurationAggregation) ValidateEnumValue 

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

type CostAnalysisUi 

type CostAnalysisUi struct {

	// The graph type.
	Graph CostAnalysisUiGraphEnum `mandatory:"false" json:"graph,omitempty"`

	// A cumulative graph.
	IsCumulativeGraph *bool `mandatory:"false" json:"isCumulativeGraph"`
}

CostAnalysisUi The common fields for Cost Analysis UI rendering.

func (CostAnalysisUi) String 

func (m CostAnalysisUi) String() string

func (CostAnalysisUi) ValidateEnumValue 

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

type CostAnalysisUiGraphEnum 

type CostAnalysisUiGraphEnum string

CostAnalysisUiGraphEnum Enum with underlying type: string 

const (
	CostAnalysisUiGraphBars         CostAnalysisUiGraphEnum = "BARS"
	CostAnalysisUiGraphLines        CostAnalysisUiGraphEnum = "LINES"
	CostAnalysisUiGraphStackedLines CostAnalysisUiGraphEnum = "STACKED_LINES"
)

Set of constants representing the allowable values for CostAnalysisUiGraphEnum

func GetCostAnalysisUiGraphEnumValues 

func GetCostAnalysisUiGraphEnumValues() []CostAnalysisUiGraphEnum

GetCostAnalysisUiGraphEnumValues Enumerates the set of values for CostAnalysisUiGraphEnum

func GetMappingCostAnalysisUiGraphEnum 

func GetMappingCostAnalysisUiGraphEnum(val string) (CostAnalysisUiGraphEnum, bool)

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

type CreateCustomTableDetails 

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

CreateCustomTableDetails New custom table detail.

func (CreateCustomTableDetails) String 

func (m CreateCustomTableDetails) String() string

func (CreateCustomTableDetails) ValidateEnumValue 

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

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

CreateCustomTableRequest wrapper for the CreateCustomTable operation

See also

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

func (CreateCustomTableRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateCustomTableRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateCustomTableRequest) RetryPolicy 

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

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

func (CreateCustomTableRequest) String 

func (request CreateCustomTableRequest) String() string

func (CreateCustomTableRequest) ValidateEnumValue 

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

type CreateCustomTableResponse 

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

CreateCustomTableResponse wrapper for the CreateCustomTable operation

func (CreateCustomTableResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateCustomTableResponse) String 

func (response CreateCustomTableResponse) String() string

type CreateEmailRecipientsGroupDetails added in v65.63.2 

type CreateEmailRecipientsGroupDetails struct {

	// The customer tenancy.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The list of recipient will receive the usage statement email.
	RecipientsList []EmailRecipient `mandatory:"true" json:"recipientsList"`
}

CreateEmailRecipientsGroupDetails The saved email recipient group to receive usage statement email.

func (CreateEmailRecipientsGroupDetails) String added in v65.63.2 

func (m CreateEmailRecipientsGroupDetails) String() string

func (CreateEmailRecipientsGroupDetails) ValidateEnumValue added in v65.63.2 

func (m CreateEmailRecipientsGroupDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateEmailRecipientsGroupRequest added in v65.63.2 

type CreateEmailRecipientsGroupRequest struct {

	// New email recipients group details.
	CreateEmailRecipientsGroupDetails `contributesTo:"body"`

	// The UsageStatement Subscription unique OCID.
	SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

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

CreateEmailRecipientsGroupRequest wrapper for the CreateEmailRecipientsGroup operation

See also

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

func (CreateEmailRecipientsGroupRequest) BinaryRequestBody added in v65.63.2 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateEmailRecipientsGroupRequest) HTTPRequest added in v65.63.2 

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

HTTPRequest implements the OCIRequest interface

func (CreateEmailRecipientsGroupRequest) RetryPolicy added in v65.63.2 

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

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

func (CreateEmailRecipientsGroupRequest) String added in v65.63.2 

func (request CreateEmailRecipientsGroupRequest) String() string

func (CreateEmailRecipientsGroupRequest) ValidateEnumValue added in v65.63.2 

func (request CreateEmailRecipientsGroupRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateEmailRecipientsGroupResponse added in v65.63.2 

type CreateEmailRecipientsGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateEmailRecipientsGroupResponse wrapper for the CreateEmailRecipientsGroup operation

func (CreateEmailRecipientsGroupResponse) HTTPResponse added in v65.63.2 

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

HTTPResponse implements the OCIResponse interface

func (CreateEmailRecipientsGroupResponse) String added in v65.63.2 

func (response CreateEmailRecipientsGroupResponse) String() string

type CreateQueryDetails 

type CreateQueryDetails struct {

	// The compartment OCID.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	QueryDefinition *QueryDefinition `mandatory:"true" json:"queryDefinition"`
}

CreateQueryDetails New query detail with savedRequestSummarizedUsagesDetails, savedCostAnalysisUI, and displayName.

func (CreateQueryDetails) String 

func (m CreateQueryDetails) String() string

func (CreateQueryDetails) ValidateEnumValue 

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

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

CreateQueryRequest wrapper for the CreateQuery operation

See also

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

func (CreateQueryRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateQueryRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateQueryRequest) RetryPolicy 

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

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

func (CreateQueryRequest) String 

func (request CreateQueryRequest) String() string

func (CreateQueryRequest) ValidateEnumValue 

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

type CreateQueryResponse 

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

CreateQueryResponse wrapper for the CreateQuery operation

func (CreateQueryResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateQueryResponse) String 

func (response CreateQueryResponse) String() string

type CreateScheduleDetails added in v65.3.0 

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

CreateScheduleDetails The saved schedule.

func (CreateScheduleDetails) String added in v65.3.0 

func (m CreateScheduleDetails) String() string

func (*CreateScheduleDetails) UnmarshalJSON added in v65.3.0 

func (m *CreateScheduleDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateScheduleDetails) ValidateEnumValue added in v65.3.0 

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

type CreateScheduleDetailsOutputFileFormatEnum added in v65.21.0 

type CreateScheduleDetailsOutputFileFormatEnum string

CreateScheduleDetailsOutputFileFormatEnum Enum with underlying type: string 

const (
	CreateScheduleDetailsOutputFileFormatCsv CreateScheduleDetailsOutputFileFormatEnum = "CSV"
	CreateScheduleDetailsOutputFileFormatPdf CreateScheduleDetailsOutputFileFormatEnum = "PDF"
)

Set of constants representing the allowable values for CreateScheduleDetailsOutputFileFormatEnum

func GetCreateScheduleDetailsOutputFileFormatEnumValues added in v65.21.0 

func GetCreateScheduleDetailsOutputFileFormatEnumValues() []CreateScheduleDetailsOutputFileFormatEnum

GetCreateScheduleDetailsOutputFileFormatEnumValues Enumerates the set of values for CreateScheduleDetailsOutputFileFormatEnum

func GetMappingCreateScheduleDetailsOutputFileFormatEnum added in v65.21.0 

func GetMappingCreateScheduleDetailsOutputFileFormatEnum(val string) (CreateScheduleDetailsOutputFileFormatEnum, bool)

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

type CreateScheduleRequest added in v65.3.0 

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
}

CreateScheduleRequest wrapper for the CreateSchedule operation

See also

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

func (CreateScheduleRequest) BinaryRequestBody added in v65.3.0 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateScheduleRequest) HTTPRequest added in v65.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateScheduleRequest) RetryPolicy added in v65.3.0 

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

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

func (CreateScheduleRequest) String added in v65.3.0 

func (request CreateScheduleRequest) String() string

func (CreateScheduleRequest) ValidateEnumValue added in v65.3.0 

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

type CreateScheduleResponse added in v65.3.0 

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

CreateScheduleResponse wrapper for the CreateSchedule operation

func (CreateScheduleResponse) HTTPResponse added in v65.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateScheduleResponse) String added in v65.3.0 

func (response CreateScheduleResponse) String() string

type CreateUsageCarbonEmissionsQueryDetails added in v65.55.0 

type CreateUsageCarbonEmissionsQueryDetails struct {

	// The compartment OCID.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	QueryDefinition *UsageCarbonEmissionsQueryDefinition `mandatory:"true" json:"queryDefinition"`
}

CreateUsageCarbonEmissionsQueryDetails New query detail with savedRequestUsageCarbonEmissionsDetails, savedCostAnalysisUI, and displayName.

func (CreateUsageCarbonEmissionsQueryDetails) String added in v65.55.0 

func (m CreateUsageCarbonEmissionsQueryDetails) String() string

func (CreateUsageCarbonEmissionsQueryDetails) ValidateEnumValue added in v65.55.0 

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

type CreateUsageCarbonEmissionsQueryRequest added in v65.55.0 

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
}

CreateUsageCarbonEmissionsQueryRequest wrapper for the CreateUsageCarbonEmissionsQuery operation

See also

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

func (CreateUsageCarbonEmissionsQueryRequest) BinaryRequestBody added in v65.55.0 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateUsageCarbonEmissionsQueryRequest) HTTPRequest added in v65.55.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateUsageCarbonEmissionsQueryRequest) RetryPolicy added in v65.55.0 

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

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

func (CreateUsageCarbonEmissionsQueryRequest) String added in v65.55.0 

func (request CreateUsageCarbonEmissionsQueryRequest) String() string

func (CreateUsageCarbonEmissionsQueryRequest) ValidateEnumValue added in v65.55.0 

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

type CreateUsageCarbonEmissionsQueryResponse added in v65.55.0 

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

CreateUsageCarbonEmissionsQueryResponse wrapper for the CreateUsageCarbonEmissionsQuery operation

func (CreateUsageCarbonEmissionsQueryResponse) HTTPResponse added in v65.55.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateUsageCarbonEmissionsQueryResponse) String added in v65.55.0 

func (response CreateUsageCarbonEmissionsQueryResponse) String() string

type CustomTable 

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

CustomTable The saved custom table.

func (CustomTable) String 

func (m CustomTable) String() string

func (CustomTable) ValidateEnumValue 

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

type CustomTableCollection 

type CustomTableCollection struct {

	// Custom tables list.
	Items []CustomTableSummary `mandatory:"true" json:"items"`
}

CustomTableCollection A custom table list.

func (CustomTableCollection) String 

func (m CustomTableCollection) String() string

func (CustomTableCollection) ValidateEnumValue 

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

type CustomTableSummary 

type CustomTableSummary struct {

	// The custom table OCID.
	Id *string `mandatory:"true" json:"id"`

	SavedCustomTable *SavedCustomTable `mandatory:"true" json:"savedCustomTable"`
}

CustomTableSummary Custom table in the list request.

func (CustomTableSummary) String 

func (m CustomTableSummary) String() string

func (CustomTableSummary) ValidateEnumValue 

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

type DateRange added in v65.3.0 

type DateRange interface {
}

DateRange Static or dynamic date range `dateRangeType`, which corresponds with type-specific characteristics.

type DateRangeDateRangeTypeEnum added in v65.3.0 

type DateRangeDateRangeTypeEnum string

DateRangeDateRangeTypeEnum Enum with underlying type: string 

const (
	DateRangeDateRangeTypeStatic  DateRangeDateRangeTypeEnum = "STATIC"
	DateRangeDateRangeTypeDynamic DateRangeDateRangeTypeEnum = "DYNAMIC"
)

Set of constants representing the allowable values for DateRangeDateRangeTypeEnum

func GetDateRangeDateRangeTypeEnumValues added in v65.3.0 

func GetDateRangeDateRangeTypeEnumValues() []DateRangeDateRangeTypeEnum

GetDateRangeDateRangeTypeEnumValues Enumerates the set of values for DateRangeDateRangeTypeEnum

func GetMappingDateRangeDateRangeTypeEnum added in v65.3.0 

func GetMappingDateRangeDateRangeTypeEnum(val string) (DateRangeDateRangeTypeEnum, bool)

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

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

DeleteCustomTableRequest wrapper for the DeleteCustomTable operation

See also

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

func (DeleteCustomTableRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteCustomTableRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteCustomTableRequest) RetryPolicy 

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

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

func (DeleteCustomTableRequest) String 

func (request DeleteCustomTableRequest) String() string

func (DeleteCustomTableRequest) ValidateEnumValue 

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

type DeleteCustomTableResponse 

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

DeleteCustomTableResponse wrapper for the DeleteCustomTable operation

func (DeleteCustomTableResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteCustomTableResponse) String 

func (response DeleteCustomTableResponse) String() string

type DeleteEmailRecipientsGroupRequest added in v65.63.2 

type DeleteEmailRecipientsGroupRequest struct {

	// The email recipient group OCID.
	EmailRecipientsGroupId *string `mandatory:"true" contributesTo:"path" name:"emailRecipientsGroupId"`

	// The UsageStatement Subscription unique OCID.
	SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

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

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

DeleteEmailRecipientsGroupRequest wrapper for the DeleteEmailRecipientsGroup operation

See also

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

func (DeleteEmailRecipientsGroupRequest) BinaryRequestBody added in v65.63.2 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteEmailRecipientsGroupRequest) HTTPRequest added in v65.63.2 

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

HTTPRequest implements the OCIRequest interface

func (DeleteEmailRecipientsGroupRequest) RetryPolicy added in v65.63.2 

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

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

func (DeleteEmailRecipientsGroupRequest) String added in v65.63.2 

func (request DeleteEmailRecipientsGroupRequest) String() string

func (DeleteEmailRecipientsGroupRequest) ValidateEnumValue added in v65.63.2 

func (request DeleteEmailRecipientsGroupRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteEmailRecipientsGroupResponse added in v65.63.2 

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

DeleteEmailRecipientsGroupResponse wrapper for the DeleteEmailRecipientsGroup operation

func (DeleteEmailRecipientsGroupResponse) HTTPResponse added in v65.63.2 

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

HTTPResponse implements the OCIResponse interface

func (DeleteEmailRecipientsGroupResponse) String added in v65.63.2 

func (response DeleteEmailRecipientsGroupResponse) String() string

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

DeleteQueryRequest wrapper for the DeleteQuery operation

See also

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

func (DeleteQueryRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteQueryRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteQueryRequest) RetryPolicy 

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

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

func (DeleteQueryRequest) String 

func (request DeleteQueryRequest) String() string

func (DeleteQueryRequest) ValidateEnumValue 

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

type DeleteQueryResponse 

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

DeleteQueryResponse wrapper for the DeleteQuery operation

func (DeleteQueryResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteQueryResponse) String 

func (response DeleteQueryResponse) String() string

type DeleteScheduleRequest added in v65.3.0 

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
}

DeleteScheduleRequest wrapper for the DeleteSchedule operation

See also

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

func (DeleteScheduleRequest) BinaryRequestBody added in v65.3.0 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteScheduleRequest) HTTPRequest added in v65.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteScheduleRequest) RetryPolicy added in v65.3.0 

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

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

func (DeleteScheduleRequest) String added in v65.3.0 

func (request DeleteScheduleRequest) String() string

func (DeleteScheduleRequest) ValidateEnumValue added in v65.3.0 

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

type DeleteScheduleResponse added in v65.3.0 

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

DeleteScheduleResponse wrapper for the DeleteSchedule operation

func (DeleteScheduleResponse) HTTPResponse added in v65.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteScheduleResponse) String added in v65.3.0 

func (response DeleteScheduleResponse) String() string

type DeleteUsageCarbonEmissionsQueryRequest added in v65.55.0 

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
}

DeleteUsageCarbonEmissionsQueryRequest wrapper for the DeleteUsageCarbonEmissionsQuery operation

See also

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

func (DeleteUsageCarbonEmissionsQueryRequest) BinaryRequestBody added in v65.55.0 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteUsageCarbonEmissionsQueryRequest) HTTPRequest added in v65.55.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteUsageCarbonEmissionsQueryRequest) RetryPolicy added in v65.55.0 

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

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

func (DeleteUsageCarbonEmissionsQueryRequest) String added in v65.55.0 

func (request DeleteUsageCarbonEmissionsQueryRequest) String() string

func (DeleteUsageCarbonEmissionsQueryRequest) ValidateEnumValue added in v65.55.0 

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

type DeleteUsageCarbonEmissionsQueryResponse added in v65.55.0 

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

DeleteUsageCarbonEmissionsQueryResponse wrapper for the DeleteUsageCarbonEmissionsQuery operation

func (DeleteUsageCarbonEmissionsQueryResponse) HTTPResponse added in v65.55.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteUsageCarbonEmissionsQueryResponse) String added in v65.55.0 

func (response DeleteUsageCarbonEmissionsQueryResponse) String() string

type Dimension 

type Dimension struct {

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

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

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

func (Dimension) String 

func (m Dimension) String() string

func (Dimension) ValidateEnumValue 

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

type DynamicDateRange added in v65.3.0 

type DynamicDateRange struct {
	DynamicDateRangeType DynamicDateRangeDynamicDateRangeTypeEnum `mandatory:"true" json:"dynamicDateRangeType"`
}

DynamicDateRange The saved dynamic date range (required when the static date range is missing).

func (DynamicDateRange) MarshalJSON added in v65.3.0 

func (m DynamicDateRange) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DynamicDateRange) String added in v65.3.0 

func (m DynamicDateRange) String() string

func (DynamicDateRange) ValidateEnumValue added in v65.3.0 

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

type DynamicDateRangeDynamicDateRangeTypeEnum added in v65.3.0 

type DynamicDateRangeDynamicDateRangeTypeEnum string

DynamicDateRangeDynamicDateRangeTypeEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for DynamicDateRangeDynamicDateRangeTypeEnum

func GetDynamicDateRangeDynamicDateRangeTypeEnumValues added in v65.3.0 

func GetDynamicDateRangeDynamicDateRangeTypeEnumValues() []DynamicDateRangeDynamicDateRangeTypeEnum

GetDynamicDateRangeDynamicDateRangeTypeEnumValues Enumerates the set of values for DynamicDateRangeDynamicDateRangeTypeEnum

func GetMappingDynamicDateRangeDynamicDateRangeTypeEnum added in v65.3.0 

func GetMappingDynamicDateRangeDynamicDateRangeTypeEnum(val string) (DynamicDateRangeDynamicDateRangeTypeEnum, bool)

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

type EmailRecipient added in v65.63.2 

type EmailRecipient struct {

	// the email of the recipient.
	EmailId *string `mandatory:"true" json:"emailId"`

	// The email recipient lifecycle state.
	LifecycleState EmailRecipientLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// the first name of the recipient.
	FirstName *string `mandatory:"false" json:"firstName"`

	// the last name of the recipient.
	LastName *string `mandatory:"false" json:"lastName"`
}

EmailRecipient The email recipient to receive usage statements for the subscription.

func (EmailRecipient) String added in v65.63.2 

func (m EmailRecipient) String() string

func (EmailRecipient) ValidateEnumValue added in v65.63.2 

func (m EmailRecipient) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type EmailRecipientLifecycleStateEnum added in v65.63.2 

type EmailRecipientLifecycleStateEnum string

EmailRecipientLifecycleStateEnum Enum with underlying type: string 

const (
	EmailRecipientLifecycleStateActive   EmailRecipientLifecycleStateEnum = "ACTIVE"
	EmailRecipientLifecycleStateInactive EmailRecipientLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for EmailRecipientLifecycleStateEnum

func GetEmailRecipientLifecycleStateEnumValues added in v65.63.2 

func GetEmailRecipientLifecycleStateEnumValues() []EmailRecipientLifecycleStateEnum

GetEmailRecipientLifecycleStateEnumValues Enumerates the set of values for EmailRecipientLifecycleStateEnum

func GetMappingEmailRecipientLifecycleStateEnum added in v65.63.2 

func GetMappingEmailRecipientLifecycleStateEnum(val string) (EmailRecipientLifecycleStateEnum, bool)

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

type EmailRecipientsGroup added in v65.63.2 

type EmailRecipientsGroup struct {

	// The usage statement email recipients group OCID.
	Id *string `mandatory:"true" json:"id"`

	// The customer tenancy OCID.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The list of recipient will receive the usage statement email.
	RecipientsList []EmailRecipient `mandatory:"true" json:"recipientsList"`

	// The email recipient group lifecycle state.
	LifecycleState EmailRecipientsGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}

EmailRecipientsGroup The recipients group to receive usage statement email.

func (EmailRecipientsGroup) String added in v65.63.2 

func (m EmailRecipientsGroup) String() string

func (EmailRecipientsGroup) ValidateEnumValue added in v65.63.2 

func (m EmailRecipientsGroup) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type EmailRecipientsGroupCollection added in v65.63.2 

type EmailRecipientsGroupCollection struct {

	// An email recipients groups list.
	Items []EmailRecipientsGroupSummary `mandatory:"true" json:"items"`
}

EmailRecipientsGroupCollection An email recipients groups collection

func (EmailRecipientsGroupCollection) String added in v65.63.2 

func (m EmailRecipientsGroupCollection) String() string

func (EmailRecipientsGroupCollection) ValidateEnumValue added in v65.63.2 

func (m EmailRecipientsGroupCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type EmailRecipientsGroupLifecycleStateEnum added in v65.63.2 

type EmailRecipientsGroupLifecycleStateEnum string

EmailRecipientsGroupLifecycleStateEnum Enum with underlying type: string 

const (
	EmailRecipientsGroupLifecycleStateActive   EmailRecipientsGroupLifecycleStateEnum = "ACTIVE"
	EmailRecipientsGroupLifecycleStateInactive EmailRecipientsGroupLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for EmailRecipientsGroupLifecycleStateEnum

func GetEmailRecipientsGroupLifecycleStateEnumValues added in v65.63.2 

func GetEmailRecipientsGroupLifecycleStateEnumValues() []EmailRecipientsGroupLifecycleStateEnum

GetEmailRecipientsGroupLifecycleStateEnumValues Enumerates the set of values for EmailRecipientsGroupLifecycleStateEnum

func GetMappingEmailRecipientsGroupLifecycleStateEnum added in v65.63.2 

func GetMappingEmailRecipientsGroupLifecycleStateEnum(val string) (EmailRecipientsGroupLifecycleStateEnum, bool)

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

type EmailRecipientsGroupSummary added in v65.63.2 

type EmailRecipientsGroupSummary struct {

	// The usage statement email recipients group OCID.
	Id *string `mandatory:"true" json:"id"`

	// The customer tenancy.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The list of recipient will receive the usage statement email.
	RecipientsList []EmailRecipient `mandatory:"true" json:"recipientsList"`

	// The email recipient group lifecycle state.
	LifecycleState EmailRecipientsGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

EmailRecipientsGroupSummary Email recipients group summary for the list recipients groups.

func (EmailRecipientsGroupSummary) String added in v65.63.2 

func (m EmailRecipientsGroupSummary) String() string

func (EmailRecipientsGroupSummary) ValidateEnumValue added in v65.63.2 

func (m EmailRecipientsGroupSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type Filter 

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

Filter The filter object for query usage.

func (Filter) String 

func (m Filter) String() string

func (Filter) ValidateEnumValue 

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

type FilterOperatorEnum 

type FilterOperatorEnum string

FilterOperatorEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for FilterOperatorEnum

func GetFilterOperatorEnumValues 

func GetFilterOperatorEnumValues() []FilterOperatorEnum

GetFilterOperatorEnumValues Enumerates the set of values for FilterOperatorEnum

func GetMappingFilterOperatorEnum 

func GetMappingFilterOperatorEnum(val string) (FilterOperatorEnum, bool)

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

type Forecast 

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

Forecast Forecast configuration of usage/cost.

func (Forecast) String 

func (m Forecast) String() string

func (Forecast) ValidateEnumValue 

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

type ForecastForecastTypeEnum 

type ForecastForecastTypeEnum string

ForecastForecastTypeEnum Enum with underlying type: string 

const (
	ForecastForecastTypeBasic ForecastForecastTypeEnum = "BASIC"
)

Set of constants representing the allowable values for ForecastForecastTypeEnum

func GetForecastForecastTypeEnumValues 

func GetForecastForecastTypeEnumValues() []ForecastForecastTypeEnum

GetForecastForecastTypeEnumValues Enumerates the set of values for ForecastForecastTypeEnum

func GetMappingForecastForecastTypeEnum 

func GetMappingForecastForecastTypeEnum(val string) (ForecastForecastTypeEnum, bool)

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

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

GetCustomTableRequest wrapper for the GetCustomTable operation

See also

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

func (GetCustomTableRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetCustomTableRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetCustomTableRequest) RetryPolicy 

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

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

func (GetCustomTableRequest) String 

func (request GetCustomTableRequest) String() string

func (GetCustomTableRequest) ValidateEnumValue 

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

type GetCustomTableResponse 

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

GetCustomTableResponse wrapper for the GetCustomTable operation

func (GetCustomTableResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetCustomTableResponse) String 

func (response GetCustomTableResponse) String() string

type GetEmailRecipientsGroupRequest added in v65.63.2 

type GetEmailRecipientsGroupRequest struct {

	// The email recipient group OCID.
	EmailRecipientsGroupId *string `mandatory:"true" contributesTo:"path" name:"emailRecipientsGroupId"`

	// The UsageStatement Subscription unique OCID.
	SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

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

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

GetEmailRecipientsGroupRequest wrapper for the GetEmailRecipientsGroup operation

See also

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

func (GetEmailRecipientsGroupRequest) BinaryRequestBody added in v65.63.2 

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

BinaryRequestBody implements the OCIRequest interface

func (GetEmailRecipientsGroupRequest) HTTPRequest added in v65.63.2 

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

HTTPRequest implements the OCIRequest interface

func (GetEmailRecipientsGroupRequest) RetryPolicy added in v65.63.2 

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

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

func (GetEmailRecipientsGroupRequest) String added in v65.63.2 

func (request GetEmailRecipientsGroupRequest) String() string

func (GetEmailRecipientsGroupRequest) ValidateEnumValue added in v65.63.2 

func (request GetEmailRecipientsGroupRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetEmailRecipientsGroupResponse added in v65.63.2 

type GetEmailRecipientsGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetEmailRecipientsGroupResponse wrapper for the GetEmailRecipientsGroup operation

func (GetEmailRecipientsGroupResponse) HTTPResponse added in v65.63.2 

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

HTTPResponse implements the OCIResponse interface

func (GetEmailRecipientsGroupResponse) String added in v65.63.2 

func (response GetEmailRecipientsGroupResponse) String() string

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

GetQueryRequest wrapper for the GetQuery operation

See also

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

func (GetQueryRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetQueryRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetQueryRequest) RetryPolicy 

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

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

func (GetQueryRequest) String 

func (request GetQueryRequest) String() string

func (GetQueryRequest) ValidateEnumValue 

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

type GetQueryResponse 

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

GetQueryResponse wrapper for the GetQuery operation

func (GetQueryResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetQueryResponse) String 

func (response GetQueryResponse) String() string

type GetScheduleRequest added in v65.3.0 

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
}

GetScheduleRequest wrapper for the GetSchedule operation

See also

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

func (GetScheduleRequest) BinaryRequestBody added in v65.3.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetScheduleRequest) HTTPRequest added in v65.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetScheduleRequest) RetryPolicy added in v65.3.0 

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

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

func (GetScheduleRequest) String added in v65.3.0 

func (request GetScheduleRequest) String() string

func (GetScheduleRequest) ValidateEnumValue added in v65.3.0 

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

type GetScheduleResponse added in v65.3.0 

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

GetScheduleResponse wrapper for the GetSchedule operation

func (GetScheduleResponse) HTTPResponse added in v65.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetScheduleResponse) String added in v65.3.0 

func (response GetScheduleResponse) String() string

type GetScheduledRunRequest added in v65.3.0 

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
}

GetScheduledRunRequest wrapper for the GetScheduledRun operation

See also

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

func (GetScheduledRunRequest) BinaryRequestBody added in v65.3.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetScheduledRunRequest) HTTPRequest added in v65.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetScheduledRunRequest) RetryPolicy added in v65.3.0 

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

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

func (GetScheduledRunRequest) String added in v65.3.0 

func (request GetScheduledRunRequest) String() string

func (GetScheduledRunRequest) ValidateEnumValue added in v65.3.0 

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

type GetScheduledRunResponse added in v65.3.0 

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

GetScheduledRunResponse wrapper for the GetScheduledRun operation

func (GetScheduledRunResponse) HTTPResponse added in v65.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetScheduledRunResponse) String added in v65.3.0 

func (response GetScheduledRunResponse) String() string

type GetUsageCarbonEmissionsQueryRequest added in v65.55.0 

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
}

GetUsageCarbonEmissionsQueryRequest wrapper for the GetUsageCarbonEmissionsQuery operation

See also

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

func (GetUsageCarbonEmissionsQueryRequest) BinaryRequestBody added in v65.55.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetUsageCarbonEmissionsQueryRequest) HTTPRequest added in v65.55.0 

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

HTTPRequest implements the OCIRequest interface

func (GetUsageCarbonEmissionsQueryRequest) RetryPolicy added in v65.55.0 

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

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

func (GetUsageCarbonEmissionsQueryRequest) String added in v65.55.0 

func (request GetUsageCarbonEmissionsQueryRequest) String() string

func (GetUsageCarbonEmissionsQueryRequest) ValidateEnumValue added in v65.55.0 

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

type GetUsageCarbonEmissionsQueryResponse added in v65.55.0 

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

GetUsageCarbonEmissionsQueryResponse wrapper for the GetUsageCarbonEmissionsQuery operation

func (GetUsageCarbonEmissionsQueryResponse) HTTPResponse added in v65.55.0 

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

HTTPResponse implements the OCIResponse interface

func (GetUsageCarbonEmissionsQueryResponse) String added in v65.55.0 

func (response GetUsageCarbonEmissionsQueryResponse) String() string

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

ListCustomTablesRequest wrapper for the ListCustomTables operation

See also

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

func (ListCustomTablesRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListCustomTablesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListCustomTablesRequest) RetryPolicy 

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

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

func (ListCustomTablesRequest) String 

func (request ListCustomTablesRequest) String() string

func (ListCustomTablesRequest) ValidateEnumValue 

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

type ListCustomTablesResponse 

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

ListCustomTablesResponse wrapper for the ListCustomTables operation

func (ListCustomTablesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListCustomTablesResponse) String 

func (response ListCustomTablesResponse) String() string

type ListCustomTablesSortByEnum 

type ListCustomTablesSortByEnum string

ListCustomTablesSortByEnum Enum with underlying type: string 

const (
	ListCustomTablesSortByDisplayname ListCustomTablesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListCustomTablesSortByEnum

func GetListCustomTablesSortByEnumValues 

func GetListCustomTablesSortByEnumValues() []ListCustomTablesSortByEnum

GetListCustomTablesSortByEnumValues Enumerates the set of values for ListCustomTablesSortByEnum

func GetMappingListCustomTablesSortByEnum 

func GetMappingListCustomTablesSortByEnum(val string) (ListCustomTablesSortByEnum, bool)

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

type ListCustomTablesSortOrderEnum 

type ListCustomTablesSortOrderEnum string

ListCustomTablesSortOrderEnum Enum with underlying type: string 

const (
	ListCustomTablesSortOrderAsc  ListCustomTablesSortOrderEnum = "ASC"
	ListCustomTablesSortOrderDesc ListCustomTablesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListCustomTablesSortOrderEnum

func GetListCustomTablesSortOrderEnumValues 

func GetListCustomTablesSortOrderEnumValues() []ListCustomTablesSortOrderEnum

GetListCustomTablesSortOrderEnumValues Enumerates the set of values for ListCustomTablesSortOrderEnum

func GetMappingListCustomTablesSortOrderEnum 

func GetMappingListCustomTablesSortOrderEnum(val string) (ListCustomTablesSortOrderEnum, bool)

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

type ListEmailRecipientsGroupsRequest added in v65.63.2 

type ListEmailRecipientsGroupsRequest struct {

	// The UsageStatement Subscription unique OCID.
	SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

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

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

	// The field to sort by. If not specified, the default is displayName.
	SortBy ListEmailRecipientsGroupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, whether 'asc' or 'desc'.
	SortOrder ListEmailRecipientsGroupsSortOrderEnum `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
}

ListEmailRecipientsGroupsRequest wrapper for the ListEmailRecipientsGroups operation

See also

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

func (ListEmailRecipientsGroupsRequest) BinaryRequestBody added in v65.63.2 

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

BinaryRequestBody implements the OCIRequest interface

func (ListEmailRecipientsGroupsRequest) HTTPRequest added in v65.63.2 

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

HTTPRequest implements the OCIRequest interface

func (ListEmailRecipientsGroupsRequest) RetryPolicy added in v65.63.2 

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

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

func (ListEmailRecipientsGroupsRequest) String added in v65.63.2 

func (request ListEmailRecipientsGroupsRequest) String() string

func (ListEmailRecipientsGroupsRequest) ValidateEnumValue added in v65.63.2 

func (request ListEmailRecipientsGroupsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListEmailRecipientsGroupsResponse added in v65.63.2 

type ListEmailRecipientsGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of EmailRecipientsGroupCollection instances
	EmailRecipientsGroupCollection `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"`
}

ListEmailRecipientsGroupsResponse wrapper for the ListEmailRecipientsGroups operation

func (ListEmailRecipientsGroupsResponse) HTTPResponse added in v65.63.2 

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

HTTPResponse implements the OCIResponse interface

func (ListEmailRecipientsGroupsResponse) String added in v65.63.2 

func (response ListEmailRecipientsGroupsResponse) String() string

type ListEmailRecipientsGroupsSortByEnum added in v65.63.2 

type ListEmailRecipientsGroupsSortByEnum string

ListEmailRecipientsGroupsSortByEnum Enum with underlying type: string 

const (
	ListEmailRecipientsGroupsSortByDisplayname ListEmailRecipientsGroupsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListEmailRecipientsGroupsSortByEnum

func GetListEmailRecipientsGroupsSortByEnumValues added in v65.63.2 

func GetListEmailRecipientsGroupsSortByEnumValues() []ListEmailRecipientsGroupsSortByEnum

GetListEmailRecipientsGroupsSortByEnumValues Enumerates the set of values for ListEmailRecipientsGroupsSortByEnum

func GetMappingListEmailRecipientsGroupsSortByEnum added in v65.63.2 

func GetMappingListEmailRecipientsGroupsSortByEnum(val string) (ListEmailRecipientsGroupsSortByEnum, bool)

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

type ListEmailRecipientsGroupsSortOrderEnum added in v65.63.2 

type ListEmailRecipientsGroupsSortOrderEnum string

ListEmailRecipientsGroupsSortOrderEnum Enum with underlying type: string 

const (
	ListEmailRecipientsGroupsSortOrderAsc  ListEmailRecipientsGroupsSortOrderEnum = "ASC"
	ListEmailRecipientsGroupsSortOrderDesc ListEmailRecipientsGroupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListEmailRecipientsGroupsSortOrderEnum

func GetListEmailRecipientsGroupsSortOrderEnumValues added in v65.63.2 

func GetListEmailRecipientsGroupsSortOrderEnumValues() []ListEmailRecipientsGroupsSortOrderEnum

GetListEmailRecipientsGroupsSortOrderEnumValues Enumerates the set of values for ListEmailRecipientsGroupsSortOrderEnum

func GetMappingListEmailRecipientsGroupsSortOrderEnum added in v65.63.2 

func GetMappingListEmailRecipientsGroupsSortOrderEnum(val string) (ListEmailRecipientsGroupsSortOrderEnum, bool)

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

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

ListQueriesRequest wrapper for the ListQueries operation

See also

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

func (ListQueriesRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListQueriesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListQueriesRequest) RetryPolicy 

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

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

func (ListQueriesRequest) String 

func (request ListQueriesRequest) String() string

func (ListQueriesRequest) ValidateEnumValue 

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

type ListQueriesResponse 

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

ListQueriesResponse wrapper for the ListQueries operation

func (ListQueriesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListQueriesResponse) String 

func (response ListQueriesResponse) String() string

type ListQueriesSortByEnum 

type ListQueriesSortByEnum string

ListQueriesSortByEnum Enum with underlying type: string 

const (
	ListQueriesSortByDisplayname ListQueriesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListQueriesSortByEnum

func GetListQueriesSortByEnumValues 

func GetListQueriesSortByEnumValues() []ListQueriesSortByEnum

GetListQueriesSortByEnumValues Enumerates the set of values for ListQueriesSortByEnum

func GetMappingListQueriesSortByEnum 

func GetMappingListQueriesSortByEnum(val string) (ListQueriesSortByEnum, bool)

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

type ListQueriesSortOrderEnum 

type ListQueriesSortOrderEnum string

ListQueriesSortOrderEnum Enum with underlying type: string 

const (
	ListQueriesSortOrderAsc  ListQueriesSortOrderEnum = "ASC"
	ListQueriesSortOrderDesc ListQueriesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListQueriesSortOrderEnum

func GetListQueriesSortOrderEnumValues 

func GetListQueriesSortOrderEnumValues() []ListQueriesSortOrderEnum

GetListQueriesSortOrderEnumValues Enumerates the set of values for ListQueriesSortOrderEnum

func GetMappingListQueriesSortOrderEnum 

func GetMappingListQueriesSortOrderEnum(val string) (ListQueriesSortOrderEnum, bool)

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

type ListScheduledRunsRequest added in v65.3.0 

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
}

ListScheduledRunsRequest wrapper for the ListScheduledRuns operation

See also

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

func (ListScheduledRunsRequest) BinaryRequestBody added in v65.3.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListScheduledRunsRequest) HTTPRequest added in v65.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListScheduledRunsRequest) RetryPolicy added in v65.3.0 

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

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

func (ListScheduledRunsRequest) String added in v65.3.0 

func (request ListScheduledRunsRequest) String() string

func (ListScheduledRunsRequest) ValidateEnumValue added in v65.3.0 

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

type ListScheduledRunsResponse added in v65.3.0 

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

ListScheduledRunsResponse wrapper for the ListScheduledRuns operation

func (ListScheduledRunsResponse) HTTPResponse added in v65.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListScheduledRunsResponse) String added in v65.3.0 

func (response ListScheduledRunsResponse) String() string

type ListScheduledRunsSortByEnum added in v65.3.0 

type ListScheduledRunsSortByEnum string

ListScheduledRunsSortByEnum Enum with underlying type: string 

const (
	ListScheduledRunsSortByTimecreated ListScheduledRunsSortByEnum = "timeCreated"
)

Set of constants representing the allowable values for ListScheduledRunsSortByEnum

func GetListScheduledRunsSortByEnumValues added in v65.3.0 

func GetListScheduledRunsSortByEnumValues() []ListScheduledRunsSortByEnum

GetListScheduledRunsSortByEnumValues Enumerates the set of values for ListScheduledRunsSortByEnum

func GetMappingListScheduledRunsSortByEnum added in v65.3.0 

func GetMappingListScheduledRunsSortByEnum(val string) (ListScheduledRunsSortByEnum, bool)

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

type ListScheduledRunsSortOrderEnum added in v65.3.0 

type ListScheduledRunsSortOrderEnum string

ListScheduledRunsSortOrderEnum Enum with underlying type: string 

const (
	ListScheduledRunsSortOrderAsc  ListScheduledRunsSortOrderEnum = "ASC"
	ListScheduledRunsSortOrderDesc ListScheduledRunsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListScheduledRunsSortOrderEnum

func GetListScheduledRunsSortOrderEnumValues added in v65.3.0 

func GetListScheduledRunsSortOrderEnumValues() []ListScheduledRunsSortOrderEnum

GetListScheduledRunsSortOrderEnumValues Enumerates the set of values for ListScheduledRunsSortOrderEnum

func GetMappingListScheduledRunsSortOrderEnum added in v65.3.0 

func GetMappingListScheduledRunsSortOrderEnum(val string) (ListScheduledRunsSortOrderEnum, bool)

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

type ListSchedulesRequest added in v65.3.0 

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
}

ListSchedulesRequest wrapper for the ListSchedules operation

See also

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

func (ListSchedulesRequest) BinaryRequestBody added in v65.3.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListSchedulesRequest) HTTPRequest added in v65.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListSchedulesRequest) RetryPolicy added in v65.3.0 

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

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

func (ListSchedulesRequest) String added in v65.3.0 

func (request ListSchedulesRequest) String() string

func (ListSchedulesRequest) ValidateEnumValue added in v65.3.0 

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

type ListSchedulesResponse added in v65.3.0 

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

ListSchedulesResponse wrapper for the ListSchedules operation

func (ListSchedulesResponse) HTTPResponse added in v65.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListSchedulesResponse) String added in v65.3.0 

func (response ListSchedulesResponse) String() string

type ListSchedulesSortByEnum added in v65.3.0 

type ListSchedulesSortByEnum string

ListSchedulesSortByEnum Enum with underlying type: string 

const (
	ListSchedulesSortByName        ListSchedulesSortByEnum = "name"
	ListSchedulesSortByTimecreated ListSchedulesSortByEnum = "timeCreated"
)

Set of constants representing the allowable values for ListSchedulesSortByEnum

func GetListSchedulesSortByEnumValues added in v65.3.0 

func GetListSchedulesSortByEnumValues() []ListSchedulesSortByEnum

GetListSchedulesSortByEnumValues Enumerates the set of values for ListSchedulesSortByEnum

func GetMappingListSchedulesSortByEnum added in v65.3.0 

func GetMappingListSchedulesSortByEnum(val string) (ListSchedulesSortByEnum, bool)

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

type ListSchedulesSortOrderEnum added in v65.3.0 

type ListSchedulesSortOrderEnum string

ListSchedulesSortOrderEnum Enum with underlying type: string 

const (
	ListSchedulesSortOrderAsc  ListSchedulesSortOrderEnum = "ASC"
	ListSchedulesSortOrderDesc ListSchedulesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSchedulesSortOrderEnum

func GetListSchedulesSortOrderEnumValues added in v65.3.0 

func GetListSchedulesSortOrderEnumValues() []ListSchedulesSortOrderEnum

GetListSchedulesSortOrderEnumValues Enumerates the set of values for ListSchedulesSortOrderEnum

func GetMappingListSchedulesSortOrderEnum added in v65.3.0 

func GetMappingListSchedulesSortOrderEnum(val string) (ListSchedulesSortOrderEnum, bool)

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

type ListUsageCarbonEmissionsQueriesRequest added in v65.55.0 

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
}

ListUsageCarbonEmissionsQueriesRequest wrapper for the ListUsageCarbonEmissionsQueries operation

See also

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

func (ListUsageCarbonEmissionsQueriesRequest) BinaryRequestBody added in v65.55.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListUsageCarbonEmissionsQueriesRequest) HTTPRequest added in v65.55.0 

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

HTTPRequest implements the OCIRequest interface

func (ListUsageCarbonEmissionsQueriesRequest) RetryPolicy added in v65.55.0 

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

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

func (ListUsageCarbonEmissionsQueriesRequest) String added in v65.55.0 

func (request ListUsageCarbonEmissionsQueriesRequest) String() string

func (ListUsageCarbonEmissionsQueriesRequest) ValidateEnumValue added in v65.55.0 

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

type ListUsageCarbonEmissionsQueriesResponse added in v65.55.0 

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

ListUsageCarbonEmissionsQueriesResponse wrapper for the ListUsageCarbonEmissionsQueries operation

func (ListUsageCarbonEmissionsQueriesResponse) HTTPResponse added in v65.55.0 

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

HTTPResponse implements the OCIResponse interface

func (ListUsageCarbonEmissionsQueriesResponse) String added in v65.55.0 

func (response ListUsageCarbonEmissionsQueriesResponse) String() string

type ListUsageCarbonEmissionsQueriesSortByEnum added in v65.55.0 

type ListUsageCarbonEmissionsQueriesSortByEnum string

ListUsageCarbonEmissionsQueriesSortByEnum Enum with underlying type: string 

const (
	ListUsageCarbonEmissionsQueriesSortByDisplayname ListUsageCarbonEmissionsQueriesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListUsageCarbonEmissionsQueriesSortByEnum

func GetListUsageCarbonEmissionsQueriesSortByEnumValues added in v65.55.0 

func GetListUsageCarbonEmissionsQueriesSortByEnumValues() []ListUsageCarbonEmissionsQueriesSortByEnum

GetListUsageCarbonEmissionsQueriesSortByEnumValues Enumerates the set of values for ListUsageCarbonEmissionsQueriesSortByEnum

func GetMappingListUsageCarbonEmissionsQueriesSortByEnum added in v65.55.0 

func GetMappingListUsageCarbonEmissionsQueriesSortByEnum(val string) (ListUsageCarbonEmissionsQueriesSortByEnum, bool)

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

type ListUsageCarbonEmissionsQueriesSortOrderEnum added in v65.55.0 

type ListUsageCarbonEmissionsQueriesSortOrderEnum string

ListUsageCarbonEmissionsQueriesSortOrderEnum Enum with underlying type: string 

const (
	ListUsageCarbonEmissionsQueriesSortOrderAsc  ListUsageCarbonEmissionsQueriesSortOrderEnum = "ASC"
	ListUsageCarbonEmissionsQueriesSortOrderDesc ListUsageCarbonEmissionsQueriesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListUsageCarbonEmissionsQueriesSortOrderEnum

func GetListUsageCarbonEmissionsQueriesSortOrderEnumValues added in v65.55.0 

func GetListUsageCarbonEmissionsQueriesSortOrderEnumValues() []ListUsageCarbonEmissionsQueriesSortOrderEnum

GetListUsageCarbonEmissionsQueriesSortOrderEnumValues Enumerates the set of values for ListUsageCarbonEmissionsQueriesSortOrderEnum

func GetMappingListUsageCarbonEmissionsQueriesSortOrderEnum added in v65.55.0 

func GetMappingListUsageCarbonEmissionsQueriesSortOrderEnum(val string) (ListUsageCarbonEmissionsQueriesSortOrderEnum, bool)

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

type ObjectStorageLocation added in v65.3.0 

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

ObjectStorageLocation The object storage location where usage or cost CSVs will be uploaded.

func (ObjectStorageLocation) MarshalJSON added in v65.3.0 

func (m ObjectStorageLocation) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ObjectStorageLocation) String added in v65.3.0 

func (m ObjectStorageLocation) String() string

func (ObjectStorageLocation) ValidateEnumValue added in v65.3.0 

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

type Query 

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

Query The query to filter and aggregate.

func (Query) String 

func (m Query) String() string

func (Query) ValidateEnumValue 

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

type QueryCollection 

type QueryCollection struct {

	// Query list.
	Items []QuerySummary `mandatory:"true" json:"items"`
}

QueryCollection A query list.

func (QueryCollection) String 

func (m QueryCollection) String() string

func (QueryCollection) ValidateEnumValue 

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

type QueryDefinition 

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

QueryDefinition The common fields for queries.

func (QueryDefinition) String 

func (m QueryDefinition) String() string

func (QueryDefinition) ValidateEnumValue 

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

type QueryProperties added in v65.3.0 

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

QueryProperties The query properties.

func (QueryProperties) String added in v65.3.0 

func (m QueryProperties) String() string

func (*QueryProperties) UnmarshalJSON added in v65.3.0 

func (m *QueryProperties) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (QueryProperties) ValidateEnumValue added in v65.3.0 

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

type QueryPropertiesGranularityEnum added in v65.3.0 

type QueryPropertiesGranularityEnum string

QueryPropertiesGranularityEnum Enum with underlying type: string 

const (
	QueryPropertiesGranularityDaily   QueryPropertiesGranularityEnum = "DAILY"
	QueryPropertiesGranularityMonthly QueryPropertiesGranularityEnum = "MONTHLY"
)

Set of constants representing the allowable values for QueryPropertiesGranularityEnum

func GetMappingQueryPropertiesGranularityEnum added in v65.3.0 

func GetMappingQueryPropertiesGranularityEnum(val string) (QueryPropertiesGranularityEnum, bool)

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

func GetQueryPropertiesGranularityEnumValues added in v65.3.0 

func GetQueryPropertiesGranularityEnumValues() []QueryPropertiesGranularityEnum

GetQueryPropertiesGranularityEnumValues Enumerates the set of values for QueryPropertiesGranularityEnum

type QueryPropertiesQueryTypeEnum added in v65.3.0 

type QueryPropertiesQueryTypeEnum string

QueryPropertiesQueryTypeEnum Enum with underlying type: string 

const (
	QueryPropertiesQueryTypeUsage        QueryPropertiesQueryTypeEnum = "USAGE"
	QueryPropertiesQueryTypeCost         QueryPropertiesQueryTypeEnum = "COST"
	QueryPropertiesQueryTypeUsageAndCost QueryPropertiesQueryTypeEnum = "USAGE_AND_COST"
)

Set of constants representing the allowable values for QueryPropertiesQueryTypeEnum

func GetMappingQueryPropertiesQueryTypeEnum added in v65.3.0 

func GetMappingQueryPropertiesQueryTypeEnum(val string) (QueryPropertiesQueryTypeEnum, bool)

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

func GetQueryPropertiesQueryTypeEnumValues added in v65.3.0 

func GetQueryPropertiesQueryTypeEnumValues() []QueryPropertiesQueryTypeEnum

GetQueryPropertiesQueryTypeEnumValues Enumerates the set of values for QueryPropertiesQueryTypeEnum

type QuerySummary 

type QuerySummary struct {

	// The query OCID.
	Id *string `mandatory:"true" json:"id"`

	QueryDefinition *QueryDefinition `mandatory:"true" json:"queryDefinition"`
}

QuerySummary Query summery in the list request.

func (QuerySummary) String 

func (m QuerySummary) String() string

func (QuerySummary) ValidateEnumValue 

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

type ReportQuery 

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

ReportQuery The request of the generated Cost Analysis report.

func (ReportQuery) String 

func (m ReportQuery) String() string

func (ReportQuery) ValidateEnumValue 

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

type ReportQueryDateRangeNameEnum 

type ReportQueryDateRangeNameEnum string

ReportQueryDateRangeNameEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for ReportQueryDateRangeNameEnum

func GetMappingReportQueryDateRangeNameEnum 

func GetMappingReportQueryDateRangeNameEnum(val string) (ReportQueryDateRangeNameEnum, bool)

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

func GetReportQueryDateRangeNameEnumValues 

func GetReportQueryDateRangeNameEnumValues() []ReportQueryDateRangeNameEnum

GetReportQueryDateRangeNameEnumValues Enumerates the set of values for ReportQueryDateRangeNameEnum

type ReportQueryGranularityEnum 

type ReportQueryGranularityEnum string

ReportQueryGranularityEnum Enum with underlying type: string 

const (
	ReportQueryGranularityHourly  ReportQueryGranularityEnum = "HOURLY"
	ReportQueryGranularityDaily   ReportQueryGranularityEnum = "DAILY"
	ReportQueryGranularityMonthly ReportQueryGranularityEnum = "MONTHLY"
	ReportQueryGranularityTotal   ReportQueryGranularityEnum = "TOTAL"
)

Set of constants representing the allowable values for ReportQueryGranularityEnum

func GetMappingReportQueryGranularityEnum 

func GetMappingReportQueryGranularityEnum(val string) (ReportQueryGranularityEnum, bool)

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

func GetReportQueryGranularityEnumValues 

func GetReportQueryGranularityEnumValues() []ReportQueryGranularityEnum

GetReportQueryGranularityEnumValues Enumerates the set of values for ReportQueryGranularityEnum

type ReportQueryQueryTypeEnum 

type ReportQueryQueryTypeEnum string

ReportQueryQueryTypeEnum Enum with underlying type: string 

const (
	ReportQueryQueryTypeUsage         ReportQueryQueryTypeEnum = "USAGE"
	ReportQueryQueryTypeCost          ReportQueryQueryTypeEnum = "COST"
	ReportQueryQueryTypeCredit        ReportQueryQueryTypeEnum = "CREDIT"
	ReportQueryQueryTypeExpiredcredit ReportQueryQueryTypeEnum = "EXPIREDCREDIT"
	ReportQueryQueryTypeAllcredit     ReportQueryQueryTypeEnum = "ALLCREDIT"
)

Set of constants representing the allowable values for ReportQueryQueryTypeEnum

func GetMappingReportQueryQueryTypeEnum 

func GetMappingReportQueryQueryTypeEnum(val string) (ReportQueryQueryTypeEnum, bool)

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

func GetReportQueryQueryTypeEnumValues 

func GetReportQueryQueryTypeEnumValues() []ReportQueryQueryTypeEnum

GetReportQueryQueryTypeEnumValues Enumerates the set of values for ReportQueryQueryTypeEnum

type RequestAverageCarbonEmissionRequest added in v65.55.0 

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
}

RequestAverageCarbonEmissionRequest wrapper for the RequestAverageCarbonEmission operation

See also

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

func (RequestAverageCarbonEmissionRequest) BinaryRequestBody added in v65.55.0 

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

BinaryRequestBody implements the OCIRequest interface

func (RequestAverageCarbonEmissionRequest) HTTPRequest added in v65.55.0 

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

HTTPRequest implements the OCIRequest interface

func (RequestAverageCarbonEmissionRequest) RetryPolicy added in v65.55.0 

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

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

func (RequestAverageCarbonEmissionRequest) String added in v65.55.0 

func (request RequestAverageCarbonEmissionRequest) String() string

func (RequestAverageCarbonEmissionRequest) ValidateEnumValue added in v65.55.0 

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

type RequestAverageCarbonEmissionResponse added in v65.55.0 

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

RequestAverageCarbonEmissionResponse wrapper for the RequestAverageCarbonEmission operation

func (RequestAverageCarbonEmissionResponse) HTTPResponse added in v65.55.0 

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

HTTPResponse implements the OCIResponse interface

func (RequestAverageCarbonEmissionResponse) String added in v65.55.0 

func (response RequestAverageCarbonEmissionResponse) String() string

type RequestCleanEnergyUsageRequest added in v65.55.0 

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
}

RequestCleanEnergyUsageRequest wrapper for the RequestCleanEnergyUsage operation

See also

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

func (RequestCleanEnergyUsageRequest) BinaryRequestBody added in v65.55.0 

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

BinaryRequestBody implements the OCIRequest interface

func (RequestCleanEnergyUsageRequest) HTTPRequest added in v65.55.0 

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

HTTPRequest implements the OCIRequest interface

func (RequestCleanEnergyUsageRequest) RetryPolicy added in v65.55.0 

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

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

func (RequestCleanEnergyUsageRequest) String added in v65.55.0 

func (request RequestCleanEnergyUsageRequest) String() string

func (RequestCleanEnergyUsageRequest) ValidateEnumValue added in v65.55.0 

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

type RequestCleanEnergyUsageResponse added in v65.55.0 

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

RequestCleanEnergyUsageResponse wrapper for the RequestCleanEnergyUsage operation

func (RequestCleanEnergyUsageResponse) HTTPResponse added in v65.55.0 

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

HTTPResponse implements the OCIResponse interface

func (RequestCleanEnergyUsageResponse) String added in v65.55.0 

func (response RequestCleanEnergyUsageResponse) String() string

type RequestSummarizedConfigurationsRequest 

type RequestSummarizedConfigurationsRequest struct {

	// tenant id
	TenantId *string `mandatory:"true" contributesTo:"query" name:"tenantId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

RequestSummarizedConfigurationsRequest wrapper for the RequestSummarizedConfigurations operation

See also

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

func (RequestSummarizedConfigurationsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (RequestSummarizedConfigurationsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (RequestSummarizedConfigurationsRequest) RetryPolicy 

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

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

func (RequestSummarizedConfigurationsRequest) String 

func (request RequestSummarizedConfigurationsRequest) String() string

func (RequestSummarizedConfigurationsRequest) ValidateEnumValue 

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

type RequestSummarizedConfigurationsResponse 

type RequestSummarizedConfigurationsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ConfigurationAggregation instance
	ConfigurationAggregation `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

RequestSummarizedConfigurationsResponse wrapper for the RequestSummarizedConfigurations operation

func (RequestSummarizedConfigurationsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (RequestSummarizedConfigurationsResponse) String 

func (response RequestSummarizedConfigurationsResponse) String() string

type RequestSummarizedUsagesDetails 

type RequestSummarizedUsagesDetails struct {

	// Tenant ID.
	TenantId *string `mandatory:"true" json:"tenantId"`

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

RequestSummarizedUsagesDetails Details for the '/usage' query.

func (RequestSummarizedUsagesDetails) String 

func (m RequestSummarizedUsagesDetails) String() string

func (RequestSummarizedUsagesDetails) ValidateEnumValue 

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

type RequestSummarizedUsagesDetailsGranularityEnum 

type RequestSummarizedUsagesDetailsGranularityEnum string

RequestSummarizedUsagesDetailsGranularityEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for RequestSummarizedUsagesDetailsGranularityEnum

func GetMappingRequestSummarizedUsagesDetailsGranularityEnum 

func GetMappingRequestSummarizedUsagesDetailsGranularityEnum(val string) (RequestSummarizedUsagesDetailsGranularityEnum, bool)

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

func GetRequestSummarizedUsagesDetailsGranularityEnumValues 

func GetRequestSummarizedUsagesDetailsGranularityEnumValues() []RequestSummarizedUsagesDetailsGranularityEnum

GetRequestSummarizedUsagesDetailsGranularityEnumValues Enumerates the set of values for RequestSummarizedUsagesDetailsGranularityEnum

type RequestSummarizedUsagesDetailsQueryTypeEnum 

type RequestSummarizedUsagesDetailsQueryTypeEnum string

RequestSummarizedUsagesDetailsQueryTypeEnum Enum with underlying type: string 

const (
	RequestSummarizedUsagesDetailsQueryTypeUsage         RequestSummarizedUsagesDetailsQueryTypeEnum = "USAGE"
	RequestSummarizedUsagesDetailsQueryTypeCost          RequestSummarizedUsagesDetailsQueryTypeEnum = "COST"
	RequestSummarizedUsagesDetailsQueryTypeCredit        RequestSummarizedUsagesDetailsQueryTypeEnum = "CREDIT"
	RequestSummarizedUsagesDetailsQueryTypeExpiredcredit RequestSummarizedUsagesDetailsQueryTypeEnum = "EXPIREDCREDIT"
	RequestSummarizedUsagesDetailsQueryTypeAllcredit     RequestSummarizedUsagesDetailsQueryTypeEnum = "ALLCREDIT"
)

Set of constants representing the allowable values for RequestSummarizedUsagesDetailsQueryTypeEnum

func GetMappingRequestSummarizedUsagesDetailsQueryTypeEnum 

func GetMappingRequestSummarizedUsagesDetailsQueryTypeEnum(val string) (RequestSummarizedUsagesDetailsQueryTypeEnum, bool)

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

func GetRequestSummarizedUsagesDetailsQueryTypeEnumValues 

func GetRequestSummarizedUsagesDetailsQueryTypeEnumValues() []RequestSummarizedUsagesDetailsQueryTypeEnum

GetRequestSummarizedUsagesDetailsQueryTypeEnumValues Enumerates the set of values for RequestSummarizedUsagesDetailsQueryTypeEnum

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

RequestSummarizedUsagesRequest wrapper for the RequestSummarizedUsages operation

See also

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

func (RequestSummarizedUsagesRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (RequestSummarizedUsagesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (RequestSummarizedUsagesRequest) RetryPolicy 

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

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

func (RequestSummarizedUsagesRequest) String 

func (request RequestSummarizedUsagesRequest) String() string

func (RequestSummarizedUsagesRequest) ValidateEnumValue 

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

type RequestSummarizedUsagesResponse 

type RequestSummarizedUsagesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of UsageAggregation instances
	UsageAggregation `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

RequestSummarizedUsagesResponse wrapper for the RequestSummarizedUsages operation

func (RequestSummarizedUsagesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (RequestSummarizedUsagesResponse) String 

func (response RequestSummarizedUsagesResponse) String() string

type RequestUsageCarbonEmissionConfigRequest added in v65.55.0 

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
}

RequestUsageCarbonEmissionConfigRequest wrapper for the RequestUsageCarbonEmissionConfig operation

See also

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

func (RequestUsageCarbonEmissionConfigRequest) BinaryRequestBody added in v65.55.0 

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

BinaryRequestBody implements the OCIRequest interface

func (RequestUsageCarbonEmissionConfigRequest) HTTPRequest added in v65.55.0 

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

HTTPRequest implements the OCIRequest interface

func (RequestUsageCarbonEmissionConfigRequest) RetryPolicy added in v65.55.0 

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

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

func (RequestUsageCarbonEmissionConfigRequest) String added in v65.55.0 

func (request RequestUsageCarbonEmissionConfigRequest) String() string

func (RequestUsageCarbonEmissionConfigRequest) ValidateEnumValue added in v65.55.0 

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

type RequestUsageCarbonEmissionConfigResponse added in v65.55.0 

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

RequestUsageCarbonEmissionConfigResponse wrapper for the RequestUsageCarbonEmissionConfig operation

func (RequestUsageCarbonEmissionConfigResponse) HTTPResponse added in v65.55.0 

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

HTTPResponse implements the OCIResponse interface

func (RequestUsageCarbonEmissionConfigResponse) String added in v65.55.0 

func (response RequestUsageCarbonEmissionConfigResponse) String() string

type RequestUsageCarbonEmissionsDetails added in v65.55.0 

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

RequestUsageCarbonEmissionsDetails Details for the '/usageCarbonEmissions' query.

func (RequestUsageCarbonEmissionsDetails) String added in v65.55.0 

func (m RequestUsageCarbonEmissionsDetails) String() string

func (RequestUsageCarbonEmissionsDetails) ValidateEnumValue added in v65.55.0 

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

type RequestUsageCarbonEmissionsRequest added in v65.55.0 

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
}

RequestUsageCarbonEmissionsRequest wrapper for the RequestUsageCarbonEmissions operation

See also

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

func (RequestUsageCarbonEmissionsRequest) BinaryRequestBody added in v65.55.0 

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

BinaryRequestBody implements the OCIRequest interface

func (RequestUsageCarbonEmissionsRequest) HTTPRequest added in v65.55.0 

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

HTTPRequest implements the OCIRequest interface

func (RequestUsageCarbonEmissionsRequest) RetryPolicy added in v65.55.0 

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

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

func (RequestUsageCarbonEmissionsRequest) String added in v65.55.0 

func (request RequestUsageCarbonEmissionsRequest) String() string

func (RequestUsageCarbonEmissionsRequest) ValidateEnumValue added in v65.55.0 

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

type RequestUsageCarbonEmissionsResponse added in v65.55.0 

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

RequestUsageCarbonEmissionsResponse wrapper for the RequestUsageCarbonEmissions operation

func (RequestUsageCarbonEmissionsResponse) HTTPResponse added in v65.55.0 

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

HTTPResponse implements the OCIResponse interface

func (RequestUsageCarbonEmissionsResponse) String added in v65.55.0 

func (response RequestUsageCarbonEmissionsResponse) String() string

type ResultLocation added in v65.3.0 

type ResultLocation interface {
}

ResultLocation The location where usage or cost CSVs will be uploaded defined by `locationType`, which corresponds with type-specific characteristics.

type ResultLocationLocationTypeEnum added in v65.3.0 

type ResultLocationLocationTypeEnum string

ResultLocationLocationTypeEnum Enum with underlying type: string 

const (
	ResultLocationLocationTypeObjectStorage ResultLocationLocationTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for ResultLocationLocationTypeEnum

func GetMappingResultLocationLocationTypeEnum added in v65.3.0 

func GetMappingResultLocationLocationTypeEnum(val string) (ResultLocationLocationTypeEnum, bool)

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

func GetResultLocationLocationTypeEnumValues added in v65.3.0 

func GetResultLocationLocationTypeEnumValues() []ResultLocationLocationTypeEnum

GetResultLocationLocationTypeEnumValues Enumerates the set of values for ResultLocationLocationTypeEnum

type SavedCustomTable 

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

SavedCustomTable The custom table for Cost Analysis UI rendering.

func (SavedCustomTable) String 

func (m SavedCustomTable) String() string

func (SavedCustomTable) ValidateEnumValue 

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

type Schedule added in v65.3.0 

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

Schedule The schedule.

func (Schedule) String added in v65.3.0 

func (m Schedule) String() string

func (*Schedule) UnmarshalJSON added in v65.3.0 

func (m *Schedule) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (Schedule) ValidateEnumValue added in v65.3.0 

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

type ScheduleCollection added in v65.3.0 

type ScheduleCollection struct {

	// Schedule summary list.
	Items []ScheduleSummary `mandatory:"true" json:"items"`
}

ScheduleCollection A schedule collection.

func (ScheduleCollection) String added in v65.3.0 

func (m ScheduleCollection) String() string

func (ScheduleCollection) ValidateEnumValue added in v65.3.0 

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

type ScheduleLifecycleStateEnum added in v65.3.0 

type ScheduleLifecycleStateEnum string

ScheduleLifecycleStateEnum Enum with underlying type: string 

const (
	ScheduleLifecycleStateActive   ScheduleLifecycleStateEnum = "ACTIVE"
	ScheduleLifecycleStateInactive ScheduleLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for ScheduleLifecycleStateEnum

func GetMappingScheduleLifecycleStateEnum added in v65.3.0 

func GetMappingScheduleLifecycleStateEnum(val string) (ScheduleLifecycleStateEnum, bool)

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

func GetScheduleLifecycleStateEnumValues added in v65.3.0 

func GetScheduleLifecycleStateEnumValues() []ScheduleLifecycleStateEnum

GetScheduleLifecycleStateEnumValues Enumerates the set of values for ScheduleLifecycleStateEnum

type ScheduleOutputFileFormatEnum added in v65.21.0 

type ScheduleOutputFileFormatEnum string

ScheduleOutputFileFormatEnum Enum with underlying type: string 

const (
	ScheduleOutputFileFormatCsv ScheduleOutputFileFormatEnum = "CSV"
	ScheduleOutputFileFormatPdf ScheduleOutputFileFormatEnum = "PDF"
)

Set of constants representing the allowable values for ScheduleOutputFileFormatEnum

func GetMappingScheduleOutputFileFormatEnum added in v65.21.0 

func GetMappingScheduleOutputFileFormatEnum(val string) (ScheduleOutputFileFormatEnum, bool)

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

func GetScheduleOutputFileFormatEnumValues added in v65.21.0 

func GetScheduleOutputFileFormatEnumValues() []ScheduleOutputFileFormatEnum

GetScheduleOutputFileFormatEnumValues Enumerates the set of values for ScheduleOutputFileFormatEnum

type ScheduleSummary added in v65.3.0 

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

ScheduleSummary Schedule summary for the list schedule.

func (ScheduleSummary) String added in v65.3.0 

func (m ScheduleSummary) String() string

func (ScheduleSummary) ValidateEnumValue added in v65.3.0 

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

type ScheduledRun added in v65.3.0 

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

ScheduledRun The saved schedule run.

func (ScheduledRun) String added in v65.3.0 

func (m ScheduledRun) String() string

func (ScheduledRun) ValidateEnumValue added in v65.3.0 

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

type ScheduledRunCollection added in v65.3.0 

type ScheduledRunCollection struct {

	// The schedule past run list.
	Items []ScheduledRunSummary `mandatory:"true" json:"items"`
}

ScheduledRunCollection The schedule past run list.

func (ScheduledRunCollection) String added in v65.3.0 

func (m ScheduledRunCollection) String() string

func (ScheduledRunCollection) ValidateEnumValue added in v65.3.0 

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

type ScheduledRunLifecycleStateEnum added in v65.3.0 

type ScheduledRunLifecycleStateEnum string

ScheduledRunLifecycleStateEnum Enum with underlying type: string 

const (
	ScheduledRunLifecycleStateFailed    ScheduledRunLifecycleStateEnum = "FAILED"
	ScheduledRunLifecycleStateSucceeded ScheduledRunLifecycleStateEnum = "SUCCEEDED"
)

Set of constants representing the allowable values for ScheduledRunLifecycleStateEnum

func GetMappingScheduledRunLifecycleStateEnum added in v65.3.0 

func GetMappingScheduledRunLifecycleStateEnum(val string) (ScheduledRunLifecycleStateEnum, bool)

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

func GetScheduledRunLifecycleStateEnumValues added in v65.3.0 

func GetScheduledRunLifecycleStateEnumValues() []ScheduledRunLifecycleStateEnum

GetScheduledRunLifecycleStateEnumValues Enumerates the set of values for ScheduledRunLifecycleStateEnum

type ScheduledRunSummary added in v65.3.0 

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

ScheduledRunSummary The saved history past run.

func (ScheduledRunSummary) String added in v65.3.0 

func (m ScheduledRunSummary) String() string

func (ScheduledRunSummary) ValidateEnumValue added in v65.3.0 

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

type StaticDateRange added in v65.3.0 

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

StaticDateRange The saved static date range (required when the dynamic date range is missing).

func (StaticDateRange) MarshalJSON added in v65.3.0 

func (m StaticDateRange) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (StaticDateRange) String added in v65.3.0 

func (m StaticDateRange) String() string

func (StaticDateRange) ValidateEnumValue added in v65.3.0 

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

type Tag 

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

Tag The tag used for filtering.

func (Tag) String 

func (m Tag) String() string

func (Tag) ValidateEnumValue 

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

type UpdateCustomTableDetails 

type UpdateCustomTableDetails struct {
	SavedCustomTable *SavedCustomTable `mandatory:"true" json:"savedCustomTable"`
}

UpdateCustomTableDetails Details for updating the custom table.

func (UpdateCustomTableDetails) String 

func (m UpdateCustomTableDetails) String() string

func (UpdateCustomTableDetails) ValidateEnumValue 

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

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

UpdateCustomTableRequest wrapper for the UpdateCustomTable operation

See also

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

func (UpdateCustomTableRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateCustomTableRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateCustomTableRequest) RetryPolicy 

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

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

func (UpdateCustomTableRequest) String 

func (request UpdateCustomTableRequest) String() string

func (UpdateCustomTableRequest) ValidateEnumValue 

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

type UpdateCustomTableResponse 

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

UpdateCustomTableResponse wrapper for the UpdateCustomTable operation

func (UpdateCustomTableResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateCustomTableResponse) String 

func (response UpdateCustomTableResponse) String() string

type UpdateEmailRecipientsGroupDetails added in v65.63.2 

type UpdateEmailRecipientsGroupDetails struct {

	// The list of recipient will receive the usage statement email.
	RecipientsList []EmailRecipient `mandatory:"true" json:"recipientsList"`
}

UpdateEmailRecipientsGroupDetails The saved email recipient group to receive usage statement email.

func (UpdateEmailRecipientsGroupDetails) String added in v65.63.2 

func (m UpdateEmailRecipientsGroupDetails) String() string

func (UpdateEmailRecipientsGroupDetails) ValidateEnumValue added in v65.63.2 

func (m UpdateEmailRecipientsGroupDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateEmailRecipientsGroupRequest added in v65.63.2 

type UpdateEmailRecipientsGroupRequest struct {

	// The information to be updated.
	UpdateEmailRecipientsGroupDetails `contributesTo:"body"`

	// The email recipient group OCID.
	EmailRecipientsGroupId *string `mandatory:"true" contributesTo:"path" name:"emailRecipientsGroupId"`

	// The UsageStatement Subscription unique OCID.
	SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

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

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

UpdateEmailRecipientsGroupRequest wrapper for the UpdateEmailRecipientsGroup operation

See also

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

func (UpdateEmailRecipientsGroupRequest) BinaryRequestBody added in v65.63.2 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateEmailRecipientsGroupRequest) HTTPRequest added in v65.63.2 

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

HTTPRequest implements the OCIRequest interface

func (UpdateEmailRecipientsGroupRequest) RetryPolicy added in v65.63.2 

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

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

func (UpdateEmailRecipientsGroupRequest) String added in v65.63.2 

func (request UpdateEmailRecipientsGroupRequest) String() string

func (UpdateEmailRecipientsGroupRequest) ValidateEnumValue added in v65.63.2 

func (request UpdateEmailRecipientsGroupRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateEmailRecipientsGroupResponse added in v65.63.2 

type UpdateEmailRecipientsGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

UpdateEmailRecipientsGroupResponse wrapper for the UpdateEmailRecipientsGroup operation

func (UpdateEmailRecipientsGroupResponse) HTTPResponse added in v65.63.2 

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

HTTPResponse implements the OCIResponse interface

func (UpdateEmailRecipientsGroupResponse) String added in v65.63.2 

func (response UpdateEmailRecipientsGroupResponse) String() string

type UpdateQueryDetails 

type UpdateQueryDetails struct {
	QueryDefinition *QueryDefinition `mandatory:"true" json:"queryDefinition"`
}

UpdateQueryDetails Details for the query to update reportQuery, costAnalysisUI, and displayName.

func (UpdateQueryDetails) String 

func (m UpdateQueryDetails) String() string

func (UpdateQueryDetails) ValidateEnumValue 

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

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

UpdateQueryRequest wrapper for the UpdateQuery operation

See also

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

func (UpdateQueryRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateQueryRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateQueryRequest) RetryPolicy 

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

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

func (UpdateQueryRequest) String 

func (request UpdateQueryRequest) String() string

func (UpdateQueryRequest) ValidateEnumValue 

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

type UpdateQueryResponse 

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

UpdateQueryResponse wrapper for the UpdateQuery operation

func (UpdateQueryResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateQueryResponse) String 

func (response UpdateQueryResponse) String() string

type UpdateScheduleDetails added in v65.3.0 

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

UpdateScheduleDetails Details for updating the custom table.

func (UpdateScheduleDetails) String added in v65.3.0 

func (m UpdateScheduleDetails) String() string

func (*UpdateScheduleDetails) UnmarshalJSON added in v65.21.0 

func (m *UpdateScheduleDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (UpdateScheduleDetails) ValidateEnumValue added in v65.3.0 

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

type UpdateScheduleDetailsOutputFileFormatEnum added in v65.21.0 

type UpdateScheduleDetailsOutputFileFormatEnum string

UpdateScheduleDetailsOutputFileFormatEnum Enum with underlying type: string 

const (
	UpdateScheduleDetailsOutputFileFormatCsv UpdateScheduleDetailsOutputFileFormatEnum = "CSV"
	UpdateScheduleDetailsOutputFileFormatPdf UpdateScheduleDetailsOutputFileFormatEnum = "PDF"
)

Set of constants representing the allowable values for UpdateScheduleDetailsOutputFileFormatEnum

func GetMappingUpdateScheduleDetailsOutputFileFormatEnum added in v65.21.0 

func GetMappingUpdateScheduleDetailsOutputFileFormatEnum(val string) (UpdateScheduleDetailsOutputFileFormatEnum, bool)

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

func GetUpdateScheduleDetailsOutputFileFormatEnumValues added in v65.21.0 

func GetUpdateScheduleDetailsOutputFileFormatEnumValues() []UpdateScheduleDetailsOutputFileFormatEnum

GetUpdateScheduleDetailsOutputFileFormatEnumValues Enumerates the set of values for UpdateScheduleDetailsOutputFileFormatEnum

type UpdateScheduleRequest added in v65.3.0 

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
}

UpdateScheduleRequest wrapper for the UpdateSchedule operation

See also

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

func (UpdateScheduleRequest) BinaryRequestBody added in v65.3.0 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateScheduleRequest) HTTPRequest added in v65.3.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateScheduleRequest) RetryPolicy added in v65.3.0 

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

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

func (UpdateScheduleRequest) String added in v65.3.0 

func (request UpdateScheduleRequest) String() string

func (UpdateScheduleRequest) ValidateEnumValue added in v65.3.0 

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

type UpdateScheduleResponse added in v65.3.0 

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

UpdateScheduleResponse wrapper for the UpdateSchedule operation

func (UpdateScheduleResponse) HTTPResponse added in v65.3.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateScheduleResponse) String added in v65.3.0 

func (response UpdateScheduleResponse) String() string

type UpdateUsageCarbonEmissionsQueryDetails added in v65.55.0 

type UpdateUsageCarbonEmissionsQueryDetails struct {
	QueryDefinition *UsageCarbonEmissionsQueryDefinition `mandatory:"true" json:"queryDefinition"`
}

UpdateUsageCarbonEmissionsQueryDetails Details for the query to update usageCarbonEmissionsQuery, costAnalysisUI, and displayName.

func (UpdateUsageCarbonEmissionsQueryDetails) String added in v65.55.0 

func (m UpdateUsageCarbonEmissionsQueryDetails) String() string

func (UpdateUsageCarbonEmissionsQueryDetails) ValidateEnumValue added in v65.55.0 

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

type UpdateUsageCarbonEmissionsQueryRequest added in v65.55.0 

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
}

UpdateUsageCarbonEmissionsQueryRequest wrapper for the UpdateUsageCarbonEmissionsQuery operation

See also

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

func (UpdateUsageCarbonEmissionsQueryRequest) BinaryRequestBody added in v65.55.0 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateUsageCarbonEmissionsQueryRequest) HTTPRequest added in v65.55.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateUsageCarbonEmissionsQueryRequest) RetryPolicy added in v65.55.0 

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

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

func (UpdateUsageCarbonEmissionsQueryRequest) String added in v65.55.0 

func (request UpdateUsageCarbonEmissionsQueryRequest) String() string

func (UpdateUsageCarbonEmissionsQueryRequest) ValidateEnumValue added in v65.55.0 

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

type UpdateUsageCarbonEmissionsQueryResponse added in v65.55.0 

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

UpdateUsageCarbonEmissionsQueryResponse wrapper for the UpdateUsageCarbonEmissionsQuery operation

func (UpdateUsageCarbonEmissionsQueryResponse) HTTPResponse added in v65.55.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateUsageCarbonEmissionsQueryResponse) String added in v65.55.0 

func (response UpdateUsageCarbonEmissionsQueryResponse) String() string

type UsageAggregation 

type UsageAggregation struct {

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

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

UsageAggregation The account (tenant) usage.

func (UsageAggregation) String 

func (m UsageAggregation) String() string

func (UsageAggregation) ValidateEnumValue 

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

type UsageCarbonEmissionAggregation added in v65.55.0 

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

UsageCarbonEmissionAggregation The account (tenant) usage carbon emissions.

func (UsageCarbonEmissionAggregation) String added in v65.55.0 

func (m UsageCarbonEmissionAggregation) String() string

func (UsageCarbonEmissionAggregation) ValidateEnumValue added in v65.55.0 

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

type UsageCarbonEmissionSummary added in v65.55.0 

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

UsageCarbonEmissionSummary The usage carbon emission store result.

func (UsageCarbonEmissionSummary) String added in v65.55.0 

func (m UsageCarbonEmissionSummary) String() string

func (UsageCarbonEmissionSummary) ValidateEnumValue added in v65.55.0 

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

type UsageCarbonEmissionsQuery added in v65.55.0 

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

UsageCarbonEmissionsQuery The usage carbon emissions saved query to filter and aggregate.

func (UsageCarbonEmissionsQuery) String added in v65.55.0 

func (m UsageCarbonEmissionsQuery) String() string

func (UsageCarbonEmissionsQuery) ValidateEnumValue added in v65.55.0 

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

type UsageCarbonEmissionsQueryCollection added in v65.55.0 

type UsageCarbonEmissionsQueryCollection struct {

	// Usage carbon emissions query list.
	Items []UsageCarbonEmissionsQuerySummary `mandatory:"true" json:"items"`
}

UsageCarbonEmissionsQueryCollection A usage carbon emissions query list.

func (UsageCarbonEmissionsQueryCollection) String added in v65.55.0 

func (m UsageCarbonEmissionsQueryCollection) String() string

func (UsageCarbonEmissionsQueryCollection) ValidateEnumValue added in v65.55.0 

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

type UsageCarbonEmissionsQueryDefinition added in v65.55.0 

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

UsageCarbonEmissionsQueryDefinition The common fields for queries.

func (UsageCarbonEmissionsQueryDefinition) String added in v65.55.0 

func (m UsageCarbonEmissionsQueryDefinition) String() string

func (UsageCarbonEmissionsQueryDefinition) ValidateEnumValue added in v65.55.0 

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

type UsageCarbonEmissionsQuerySummary added in v65.55.0 

type UsageCarbonEmissionsQuerySummary struct {

	// The query OCID.
	Id *string `mandatory:"true" json:"id"`

	QueryDefinition *UsageCarbonEmissionsQueryDefinition `mandatory:"true" json:"queryDefinition"`
}

UsageCarbonEmissionsQuerySummary Usage carbon emissions query summary in the list request.

func (UsageCarbonEmissionsQuerySummary) String added in v65.55.0 

func (m UsageCarbonEmissionsQuerySummary) String() string

func (UsageCarbonEmissionsQuerySummary) ValidateEnumValue added in v65.55.0 

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

type UsageCarbonEmissionsReportQuery added in v65.55.0 

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

UsageCarbonEmissionsReportQuery The request of the generated usage carbon emissions report.

func (UsageCarbonEmissionsReportQuery) String added in v65.55.0 

func (m UsageCarbonEmissionsReportQuery) String() string

func (UsageCarbonEmissionsReportQuery) ValidateEnumValue added in v65.55.0 

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

type UsageCarbonEmissionsReportQueryDateRangeNameEnum added in v65.55.0 

type UsageCarbonEmissionsReportQueryDateRangeNameEnum string

UsageCarbonEmissionsReportQueryDateRangeNameEnum Enum with underlying type: string 

const (
	UsageCarbonEmissionsReportQueryDateRangeNameLastTwoMonths   UsageCarbonEmissionsReportQueryDateRangeNameEnum = "LAST_TWO_MONTHS"
	UsageCarbonEmissionsReportQueryDateRangeNameLastThreeMonths UsageCarbonEmissionsReportQueryDateRangeNameEnum = "LAST_THREE_MONTHS"
	UsageCarbonEmissionsReportQueryDateRangeNameLastSixMonths   UsageCarbonEmissionsReportQueryDateRangeNameEnum = "LAST_SIX_MONTHS"
	UsageCarbonEmissionsReportQueryDateRangeNameLastOneYear     UsageCarbonEmissionsReportQueryDateRangeNameEnum = "LAST_ONE_YEAR"
	UsageCarbonEmissionsReportQueryDateRangeNameCustom          UsageCarbonEmissionsReportQueryDateRangeNameEnum = "CUSTOM"
)

Set of constants representing the allowable values for UsageCarbonEmissionsReportQueryDateRangeNameEnum

func GetMappingUsageCarbonEmissionsReportQueryDateRangeNameEnum added in v65.55.0 

func GetMappingUsageCarbonEmissionsReportQueryDateRangeNameEnum(val string) (UsageCarbonEmissionsReportQueryDateRangeNameEnum, bool)

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

func GetUsageCarbonEmissionsReportQueryDateRangeNameEnumValues added in v65.55.0 

func GetUsageCarbonEmissionsReportQueryDateRangeNameEnumValues() []UsageCarbonEmissionsReportQueryDateRangeNameEnum

GetUsageCarbonEmissionsReportQueryDateRangeNameEnumValues Enumerates the set of values for UsageCarbonEmissionsReportQueryDateRangeNameEnum

type UsageSummary 

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 attributed cost with a max value of 9999999999.999999999999 and a minimum value of 0.
	AttributedCost *string `mandatory:"false" json:"attributedCost"`

	// The attributed usage with a max value of 9999999999.999999999999 and a minimum value of 0.
	AttributedUsage *string `mandatory:"false" json:"attributedUsage"`

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

UsageSummary The usage store result.

func (UsageSummary) String 

func (m UsageSummary) String() string

func (UsageSummary) ValidateEnumValue 

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

type UsageapiClient 

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

UsageapiClient a client for Usageapi

func NewUsageapiClientWithConfigurationProvider 

func NewUsageapiClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client UsageapiClient, err error)

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

func NewUsageapiClientWithOboToken 

func NewUsageapiClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client UsageapiClient, err error)

NewUsageapiClientWithOboToken Creates a new default Usageapi client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer 

as well as reading the region

func (*UsageapiClient) ConfigurationProvider 

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

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

func (UsageapiClient) CreateCustomTable 

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/latest/usageapi/CreateCustomTable.go.html to see an example of how to use CreateCustomTable API.

func (UsageapiClient) CreateEmailRecipientsGroup added in v65.63.2 

func (client UsageapiClient) CreateEmailRecipientsGroup(ctx context.Context, request CreateEmailRecipientsGroupRequest) (response CreateEmailRecipientsGroupResponse, err error)

CreateEmailRecipientsGroup Add a list of email recipients that can receive usage statements for the subscription.

See also

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

func (UsageapiClient) CreateQuery 

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/latest/usageapi/CreateQuery.go.html to see an example of how to use CreateQuery API.

func (UsageapiClient) CreateSchedule added in v65.3.0 

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/latest/usageapi/CreateSchedule.go.html to see an example of how to use CreateSchedule API.

func (UsageapiClient) CreateUsageCarbonEmissionsQuery added in v65.55.0 

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/latest/usageapi/CreateUsageCarbonEmissionsQuery.go.html to see an example of how to use CreateUsageCarbonEmissionsQuery API.

func (UsageapiClient) DeleteCustomTable 

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/latest/usageapi/DeleteCustomTable.go.html to see an example of how to use DeleteCustomTable API.

func (UsageapiClient) DeleteEmailRecipientsGroup added in v65.63.2 

func (client UsageapiClient) DeleteEmailRecipientsGroup(ctx context.Context, request DeleteEmailRecipientsGroupRequest) (response DeleteEmailRecipientsGroupResponse, err error)

DeleteEmailRecipientsGroup Delete the email recipients group for the usage statement subscription.

See also

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

func (UsageapiClient) DeleteQuery 

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/latest/usageapi/DeleteQuery.go.html to see an example of how to use DeleteQuery API.

func (UsageapiClient) DeleteSchedule added in v65.3.0 

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/latest/usageapi/DeleteSchedule.go.html to see an example of how to use DeleteSchedule API.

func (UsageapiClient) DeleteUsageCarbonEmissionsQuery added in v65.55.0 

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/latest/usageapi/DeleteUsageCarbonEmissionsQuery.go.html to see an example of how to use DeleteUsageCarbonEmissionsQuery API.

func (UsageapiClient) GetCustomTable 

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/latest/usageapi/GetCustomTable.go.html to see an example of how to use GetCustomTable API.

func (UsageapiClient) GetEmailRecipientsGroup added in v65.63.2 

func (client UsageapiClient) GetEmailRecipientsGroup(ctx context.Context, request GetEmailRecipientsGroupRequest) (response GetEmailRecipientsGroupResponse, err error)

GetEmailRecipientsGroup Return the saved usage statement email recipient group.

See also

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

func (UsageapiClient) GetQuery 

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/latest/usageapi/GetQuery.go.html to see an example of how to use GetQuery API.

func (UsageapiClient) GetSchedule added in v65.3.0 

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/latest/usageapi/GetSchedule.go.html to see an example of how to use GetSchedule API.

func (UsageapiClient) GetScheduledRun added in v65.3.0 

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/latest/usageapi/GetScheduledRun.go.html to see an example of how to use GetScheduledRun API.

func (UsageapiClient) GetUsageCarbonEmissionsQuery added in v65.55.0 

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/latest/usageapi/GetUsageCarbonEmissionsQuery.go.html to see an example of how to use GetUsageCarbonEmissionsQuery API.

func (UsageapiClient) ListCustomTables 

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/latest/usageapi/ListCustomTables.go.html to see an example of how to use ListCustomTables API.

func (UsageapiClient) ListEmailRecipientsGroups added in v65.63.2 

func (client UsageapiClient) ListEmailRecipientsGroups(ctx context.Context, request ListEmailRecipientsGroupsRequest) (response ListEmailRecipientsGroupsResponse, err error)

ListEmailRecipientsGroups Return the saved usage statement email recipient group.

See also

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

func (UsageapiClient) ListQueries 

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/latest/usageapi/ListQueries.go.html to see an example of how to use ListQueries API.

func (UsageapiClient) ListScheduledRuns added in v65.3.0 

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/latest/usageapi/ListScheduledRuns.go.html to see an example of how to use ListScheduledRuns API.

func (UsageapiClient) ListSchedules added in v65.3.0 

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/latest/usageapi/ListSchedules.go.html to see an example of how to use ListSchedules API.

func (UsageapiClient) ListUsageCarbonEmissionsQueries added in v65.55.0 

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/latest/usageapi/ListUsageCarbonEmissionsQueries.go.html to see an example of how to use ListUsageCarbonEmissionsQueries API.

func (UsageapiClient) RequestAverageCarbonEmission added in v65.55.0 

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/latest/usageapi/RequestAverageCarbonEmission.go.html to see an example of how to use RequestAverageCarbonEmission API.

func (UsageapiClient) RequestCleanEnergyUsage added in v65.55.0 

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/latest/usageapi/RequestCleanEnergyUsage.go.html to see an example of how to use RequestCleanEnergyUsage API.

func (UsageapiClient) RequestSummarizedConfigurations 

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/latest/usageapi/RequestSummarizedConfigurations.go.html to see an example of how to use RequestSummarizedConfigurations API.

func (UsageapiClient) RequestSummarizedUsages 

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/latest/usageapi/RequestSummarizedUsages.go.html to see an example of how to use RequestSummarizedUsages API.

func (UsageapiClient) RequestUsageCarbonEmissionConfig added in v65.55.0 

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/latest/usageapi/RequestUsageCarbonEmissionConfig.go.html to see an example of how to use RequestUsageCarbonEmissionConfig API.

func (UsageapiClient) RequestUsageCarbonEmissions added in v65.55.0 

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/latest/usageapi/RequestUsageCarbonEmissions.go.html to see an example of how to use RequestUsageCarbonEmissions API.

func (*UsageapiClient) SetRegion 

func (client *UsageapiClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (UsageapiClient) UpdateCustomTable 

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/latest/usageapi/UpdateCustomTable.go.html to see an example of how to use UpdateCustomTable API.

func (UsageapiClient) UpdateEmailRecipientsGroup added in v65.63.2 

func (client UsageapiClient) UpdateEmailRecipientsGroup(ctx context.Context, request UpdateEmailRecipientsGroupRequest) (response UpdateEmailRecipientsGroupResponse, err error)

UpdateEmailRecipientsGroup Update a saved email recipients group.

See also

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

func (UsageapiClient) UpdateQuery 

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/latest/usageapi/UpdateQuery.go.html to see an example of how to use UpdateQuery API.

func (UsageapiClient) UpdateSchedule added in v65.3.0 

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/latest/usageapi/UpdateSchedule.go.html to see an example of how to use UpdateSchedule API.

func (UsageapiClient) UpdateUsageCarbonEmissionsQuery added in v65.55.0 

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/latest/usageapi/UpdateUsageCarbonEmissionsQuery.go.html to see an example of how to use UpdateUsageCarbonEmissionsQuery API.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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