func GetListProductsProducttypeEnumStringValues() []string
GetListProductsProducttypeEnumStringValues Enumerates the set of values in String for ListProductsProducttypeEnum
func GetListProductsSortByEnumStringValues() []string
GetListProductsSortByEnumStringValues Enumerates the set of values in String for ListProductsSortByEnum
func GetListProductsSortOrderEnumStringValues() []string
GetListProductsSortOrderEnumStringValues Enumerates the set of values in String for ListProductsSortOrderEnum
func GetListRedeemableUsersSortByEnumStringValues() []string
GetListRedeemableUsersSortByEnumStringValues Enumerates the set of values in String for ListRedeemableUsersSortByEnum
func GetListRedeemableUsersSortOrderEnumStringValues() []string
GetListRedeemableUsersSortOrderEnumStringValues Enumerates the set of values in String for ListRedeemableUsersSortOrderEnum
func GetListRedemptionsSortByEnumStringValues() []string
GetListRedemptionsSortByEnumStringValues Enumerates the set of values in String for ListRedemptionsSortByEnum
func GetListRedemptionsSortOrderEnumStringValues() []string
GetListRedemptionsSortOrderEnumStringValues Enumerates the set of values in String for ListRedemptionsSortOrderEnum
func GetListResourceQuotaSortByEnumStringValues() []string
GetListResourceQuotaSortByEnumStringValues Enumerates the set of values in String for ListResourceQuotaSortByEnum
func GetListResourceQuotaSortOrderEnumStringValues() []string
GetListResourceQuotaSortOrderEnumStringValues Enumerates the set of values in String for ListResourceQuotaSortOrderEnum
func GetListResourcesSortByEnumStringValues() []string
GetListResourcesSortByEnumStringValues Enumerates the set of values in String for ListResourcesSortByEnum
func GetListResourcesSortOrderEnumStringValues() []string
GetListResourcesSortOrderEnumStringValues Enumerates the set of values in String for ListResourcesSortOrderEnum
func GetListUsageLimitsSortByEnumStringValues() []string
GetListUsageLimitsSortByEnumStringValues Enumerates the set of values in String for ListUsageLimitsSortByEnum
func GetListUsageLimitsSortOrderEnumStringValues() []string
GetListUsageLimitsSortOrderEnumStringValues Enumerates the set of values in String for ListUsageLimitsSortOrderEnum
func GetResourceSummaryUsageDataTypeEnumStringValues() []string
GetResourceSummaryUsageDataTypeEnumStringValues Enumerates the set of values in String for ResourceSummaryUsageDataTypeEnum
func GetUsageLimitSummaryActionEnumStringValues() []string
GetUsageLimitSummaryActionEnumStringValues Enumerates the set of values in String for UsageLimitSummaryActionEnum
func GetUsageLimitSummaryLifecycleStateEnumStringValues() []string
GetUsageLimitSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for UsageLimitSummaryLifecycleStateEnum
func GetUsageLimitSummaryLimitTypeEnumStringValues() []string
GetUsageLimitSummaryLimitTypeEnumStringValues Enumerates the set of values in String for UsageLimitSummaryLimitTypeEnum
func GetUsageLimitSummaryValueTypeEnumStringValues() []string
GetUsageLimitSummaryValueTypeEnumStringValues Enumerates the set of values in String for UsageLimitSummaryValueTypeEnum
CreateRedeemableUserDetails A list of new user to be added to the list of user that can redeem rewards.
type CreateRedeemableUserDetails struct {
// The list of new user to be added to the list of user that can redeem rewards.
Items []RedeemableUser `mandatory:"false" json:"items"`
}
func (m CreateRedeemableUserDetails) String() string
func (m CreateRedeemableUserDetails) 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
CreateRedeemableUserRequest wrapper for the CreateRedeemableUser operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/CreateRedeemableUser.go.html to see an example of how to use CreateRedeemableUserRequest.
type CreateRedeemableUserRequest struct {
// CreateRedeemableUserDetails information.
CreateRedeemableUserDetails `contributesTo:"body"`
// The OCID of the tenancy.
TenancyId *string `mandatory:"true" contributesTo:"query" name:"tenancyId"`
// The subscription ID for which rewards information is requested for.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The user ID of the person to send a copy of an email.
UserId *string `mandatory:"false" contributesTo:"query" name:"userId"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error, without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateRedeemableUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRedeemableUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRedeemableUserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRedeemableUserRequest) String() string
func (request CreateRedeemableUserRequest) 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
CreateRedeemableUserResponse wrapper for the CreateRedeemableUser operation
type CreateRedeemableUserResponse struct {
// The underlying http response
RawResponse *http.Response
// The RedeemableUserCollection instance
RedeemableUserCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateRedeemableUserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRedeemableUserResponse) String() string
DeleteRedeemableUserRequest wrapper for the DeleteRedeemableUser operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/DeleteRedeemableUser.go.html to see an example of how to use DeleteRedeemableUserRequest.
type DeleteRedeemableUserRequest struct {
// The email ID that needs to be deleted.
EmailId *string `mandatory:"true" contributesTo:"query" name:"emailId"`
// The OCID of the tenancy.
TenancyId *string `mandatory:"true" contributesTo:"query" name:"tenancyId"`
// The subscription ID for which rewards information is requested for.
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"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted, only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteRedeemableUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRedeemableUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRedeemableUserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRedeemableUserRequest) String() string
func (request DeleteRedeemableUserRequest) 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
DeleteRedeemableUserResponse wrapper for the DeleteRedeemableUser operation
type DeleteRedeemableUserResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteRedeemableUserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRedeemableUserResponse) String() string
ListProductsProducttypeEnum Enum with underlying type: string
type ListProductsProducttypeEnum string
Set of constants representing the allowable values for ListProductsProducttypeEnum
const (
ListProductsProducttypeAll ListProductsProducttypeEnum = "ALL"
ListProductsProducttypeEligible ListProductsProducttypeEnum = "ELIGIBLE"
ListProductsProducttypeIneligible ListProductsProducttypeEnum = "INELIGIBLE"
)
func GetListProductsProducttypeEnumValues() []ListProductsProducttypeEnum
GetListProductsProducttypeEnumValues Enumerates the set of values for ListProductsProducttypeEnum
func GetMappingListProductsProducttypeEnum(val string) (ListProductsProducttypeEnum, bool)
GetMappingListProductsProducttypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListProductsRequest wrapper for the ListProducts operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListProducts.go.html to see an example of how to use ListProductsRequest.
type ListProductsRequest struct {
// The OCID of the tenancy.
TenancyId *string `mandatory:"true" contributesTo:"query" name:"tenancyId"`
// The subscription ID for which rewards information is requested for.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The SPM Identifier for the usage period.
UsagePeriodKey *string `mandatory:"true" contributesTo:"query" name:"usagePeriodKey"`
// 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 value of the 'opc-next-page' response header from the previous call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in the paginated response.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, which can be ascending (ASC) or descending (DESC).
SortOrder ListProductsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Supports one sort order.
SortBy ListProductsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The field to specify the type of product.
Producttype ListProductsProducttypeEnum `mandatory:"false" contributesTo:"query" name:"producttype" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListProductsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListProductsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListProductsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProductsRequest) String() string
func (request ListProductsRequest) 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
ListProductsResponse wrapper for the ListProducts operation
type ListProductsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ProductCollection instances
ProductCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListProductsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListProductsResponse) String() string
ListProductsSortByEnum Enum with underlying type: string
type ListProductsSortByEnum string
Set of constants representing the allowable values for ListProductsSortByEnum
const (
ListProductsSortByTimecreated ListProductsSortByEnum = "TIMECREATED"
ListProductsSortByTimestart ListProductsSortByEnum = "TIMESTART"
)
func GetListProductsSortByEnumValues() []ListProductsSortByEnum
GetListProductsSortByEnumValues Enumerates the set of values for ListProductsSortByEnum
func GetMappingListProductsSortByEnum(val string) (ListProductsSortByEnum, bool)
GetMappingListProductsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListProductsSortOrderEnum Enum with underlying type: string
type ListProductsSortOrderEnum string
Set of constants representing the allowable values for ListProductsSortOrderEnum
const (
ListProductsSortOrderAsc ListProductsSortOrderEnum = "ASC"
ListProductsSortOrderDesc ListProductsSortOrderEnum = "DESC"
)
func GetListProductsSortOrderEnumValues() []ListProductsSortOrderEnum
GetListProductsSortOrderEnumValues Enumerates the set of values for ListProductsSortOrderEnum
func GetMappingListProductsSortOrderEnum(val string) (ListProductsSortOrderEnum, bool)
GetMappingListProductsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRedeemableUsersRequest wrapper for the ListRedeemableUsers operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListRedeemableUsers.go.html to see an example of how to use ListRedeemableUsersRequest.
type ListRedeemableUsersRequest struct {
// The OCID of the tenancy.
TenancyId *string `mandatory:"true" contributesTo:"query" name:"tenancyId"`
// The subscription ID for which rewards information is requested for.
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"`
// The value of the 'opc-next-page' response header from the previous call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in the paginated response.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, which can be ascending (ASC) or descending (DESC).
SortOrder ListRedeemableUsersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Supports one sort order.
SortBy ListRedeemableUsersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRedeemableUsersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRedeemableUsersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRedeemableUsersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRedeemableUsersRequest) String() string
func (request ListRedeemableUsersRequest) 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
ListRedeemableUsersResponse wrapper for the ListRedeemableUsers operation
type ListRedeemableUsersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RedeemableUserCollection instances
RedeemableUserCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListRedeemableUsersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRedeemableUsersResponse) String() string
ListRedeemableUsersSortByEnum Enum with underlying type: string
type ListRedeemableUsersSortByEnum string
Set of constants representing the allowable values for ListRedeemableUsersSortByEnum
const (
ListRedeemableUsersSortByTimecreated ListRedeemableUsersSortByEnum = "TIMECREATED"
ListRedeemableUsersSortByTimestart ListRedeemableUsersSortByEnum = "TIMESTART"
)
func GetListRedeemableUsersSortByEnumValues() []ListRedeemableUsersSortByEnum
GetListRedeemableUsersSortByEnumValues Enumerates the set of values for ListRedeemableUsersSortByEnum
func GetMappingListRedeemableUsersSortByEnum(val string) (ListRedeemableUsersSortByEnum, bool)
GetMappingListRedeemableUsersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRedeemableUsersSortOrderEnum Enum with underlying type: string
type ListRedeemableUsersSortOrderEnum string
Set of constants representing the allowable values for ListRedeemableUsersSortOrderEnum
const (
ListRedeemableUsersSortOrderAsc ListRedeemableUsersSortOrderEnum = "ASC"
ListRedeemableUsersSortOrderDesc ListRedeemableUsersSortOrderEnum = "DESC"
)
func GetListRedeemableUsersSortOrderEnumValues() []ListRedeemableUsersSortOrderEnum
GetListRedeemableUsersSortOrderEnumValues Enumerates the set of values for ListRedeemableUsersSortOrderEnum
func GetMappingListRedeemableUsersSortOrderEnum(val string) (ListRedeemableUsersSortOrderEnum, bool)
GetMappingListRedeemableUsersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRedemptionsRequest wrapper for the ListRedemptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListRedemptions.go.html to see an example of how to use ListRedemptionsRequest.
type ListRedemptionsRequest struct {
// The OCID of the tenancy.
TenancyId *string `mandatory:"true" contributesTo:"query" name:"tenancyId"`
// The subscription ID for which rewards information is requested for.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The starting redeemed date filter for the redemption history.
TimeRedeemedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeRedeemedGreaterThanOrEqualTo"`
// The ending redeemed date filter for the redemption history.
TimeRedeemedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeRedeemedLessThan"`
// 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 value of the 'opc-next-page' response header from the previous call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in the paginated response.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, which can be ascending (ASC) or descending (DESC).
SortOrder ListRedemptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to be used only for list redemptions API. Supports one sort order.
SortBy ListRedemptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRedemptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRedemptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRedemptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRedemptionsRequest) String() string
func (request ListRedemptionsRequest) 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
ListRedemptionsResponse wrapper for the ListRedemptions operation
type ListRedemptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RedemptionCollection instances
RedemptionCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListRedemptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRedemptionsResponse) String() string
ListRedemptionsSortByEnum Enum with underlying type: string
type ListRedemptionsSortByEnum string
Set of constants representing the allowable values for ListRedemptionsSortByEnum
const (
ListRedemptionsSortByTimeredeemed ListRedemptionsSortByEnum = "TIMEREDEEMED"
)
func GetListRedemptionsSortByEnumValues() []ListRedemptionsSortByEnum
GetListRedemptionsSortByEnumValues Enumerates the set of values for ListRedemptionsSortByEnum
func GetMappingListRedemptionsSortByEnum(val string) (ListRedemptionsSortByEnum, bool)
GetMappingListRedemptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRedemptionsSortOrderEnum Enum with underlying type: string
type ListRedemptionsSortOrderEnum string
Set of constants representing the allowable values for ListRedemptionsSortOrderEnum
const (
ListRedemptionsSortOrderAsc ListRedemptionsSortOrderEnum = "ASC"
ListRedemptionsSortOrderDesc ListRedemptionsSortOrderEnum = "DESC"
)
func GetListRedemptionsSortOrderEnumValues() []ListRedemptionsSortOrderEnum
GetListRedemptionsSortOrderEnumValues Enumerates the set of values for ListRedemptionsSortOrderEnum
func GetMappingListRedemptionsSortOrderEnum(val string) (ListRedemptionsSortOrderEnum, bool)
GetMappingListRedemptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListResourceQuotaRequest wrapper for the ListResourceQuota operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListResourceQuota.go.html to see an example of how to use ListResourceQuotaRequest.
type ListResourceQuotaRequest struct {
// Service Name.
ServiceName *string `mandatory:"true" contributesTo:"query" name:"serviceName"`
// The OCID of the root compartment.
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"`
// Service entitlement Id.
ServiceEntitlement *string `mandatory:"false" contributesTo:"query" name:"serviceEntitlement"`
// The value of the 'opc-next-page' response header from the previous call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in the paginated response.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, which can be ascending (ASC) or descending (DESC).
SortOrder ListResourceQuotaSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Supports one sort order.
SortBy ListResourceQuotaSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListResourceQuotaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListResourceQuotaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListResourceQuotaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListResourceQuotaRequest) String() string
func (request ListResourceQuotaRequest) 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
ListResourceQuotaResponse wrapper for the ListResourceQuota operation
type ListResourceQuotaResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ResourceQuotumCollection instances
ResourceQuotumCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListResourceQuotaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListResourceQuotaResponse) String() string
ListResourceQuotaSortByEnum Enum with underlying type: string
type ListResourceQuotaSortByEnum string
Set of constants representing the allowable values for ListResourceQuotaSortByEnum
const (
ListResourceQuotaSortByTimecreated ListResourceQuotaSortByEnum = "TIMECREATED"
ListResourceQuotaSortByTimestart ListResourceQuotaSortByEnum = "TIMESTART"
)
func GetListResourceQuotaSortByEnumValues() []ListResourceQuotaSortByEnum
GetListResourceQuotaSortByEnumValues Enumerates the set of values for ListResourceQuotaSortByEnum
func GetMappingListResourceQuotaSortByEnum(val string) (ListResourceQuotaSortByEnum, bool)
GetMappingListResourceQuotaSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListResourceQuotaSortOrderEnum Enum with underlying type: string
type ListResourceQuotaSortOrderEnum string
Set of constants representing the allowable values for ListResourceQuotaSortOrderEnum
const (
ListResourceQuotaSortOrderAsc ListResourceQuotaSortOrderEnum = "ASC"
ListResourceQuotaSortOrderDesc ListResourceQuotaSortOrderEnum = "DESC"
)
func GetListResourceQuotaSortOrderEnumValues() []ListResourceQuotaSortOrderEnum
GetListResourceQuotaSortOrderEnumValues Enumerates the set of values for ListResourceQuotaSortOrderEnum
func GetMappingListResourceQuotaSortOrderEnum(val string) (ListResourceQuotaSortOrderEnum, bool)
GetMappingListResourceQuotaSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListResourcesRequest wrapper for the ListResources operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListResources.go.html to see an example of how to use ListResourcesRequest.
type ListResourcesRequest struct {
// Service Name.
ServiceName *string `mandatory:"true" contributesTo:"query" name:"serviceName"`
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Subscription or entitlement Id.
EntitlementId *string `mandatory:"false" contributesTo:"query" name:"entitlementId"`
// 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 value of the 'opc-next-page' response header from the previous call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in the paginated response.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, which can be ascending (ASC) or descending (DESC).
SortOrder ListResourcesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Supports one sort order.
SortBy ListResourcesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListResourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListResourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListResourcesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListResourcesRequest) String() string
func (request ListResourcesRequest) 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
ListResourcesResponse wrapper for the ListResources operation
type ListResourcesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ResourcesCollection instances
ResourcesCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListResourcesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListResourcesResponse) String() string
ListResourcesSortByEnum Enum with underlying type: string
type ListResourcesSortByEnum string
Set of constants representing the allowable values for ListResourcesSortByEnum
const (
ListResourcesSortByTimecreated ListResourcesSortByEnum = "TIMECREATED"
ListResourcesSortByTimestart ListResourcesSortByEnum = "TIMESTART"
)
func GetListResourcesSortByEnumValues() []ListResourcesSortByEnum
GetListResourcesSortByEnumValues Enumerates the set of values for ListResourcesSortByEnum
func GetMappingListResourcesSortByEnum(val string) (ListResourcesSortByEnum, bool)
GetMappingListResourcesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListResourcesSortOrderEnum Enum with underlying type: string
type ListResourcesSortOrderEnum string
Set of constants representing the allowable values for ListResourcesSortOrderEnum
const (
ListResourcesSortOrderAsc ListResourcesSortOrderEnum = "ASC"
ListResourcesSortOrderDesc ListResourcesSortOrderEnum = "DESC"
)
func GetListResourcesSortOrderEnumValues() []ListResourcesSortOrderEnum
GetListResourcesSortOrderEnumValues Enumerates the set of values for ListResourcesSortOrderEnum
func GetMappingListResourcesSortOrderEnum(val string) (ListResourcesSortOrderEnum, bool)
GetMappingListResourcesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRewardsRequest wrapper for the ListRewards operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListRewards.go.html to see an example of how to use ListRewardsRequest.
type ListRewardsRequest struct {
// The OCID of the tenancy.
TenancyId *string `mandatory:"true" contributesTo:"query" name:"tenancyId"`
// The subscription ID for which rewards information is requested for.
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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRewardsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRewardsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRewardsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRewardsRequest) String() string
func (request ListRewardsRequest) 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
ListRewardsResponse wrapper for the ListRewards operation
type ListRewardsResponse struct {
// The underlying http response
RawResponse *http.Response
// The RewardCollection instance
RewardCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListRewardsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRewardsResponse) String() string
ListUsageLimitsRequest wrapper for the ListUsageLimits operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListUsageLimits.go.html to see an example of how to use ListUsageLimitsRequest.
type ListUsageLimitsRequest struct {
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The subscription ID for which rewards information is requested for.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// Hard or soft limit. Hard limits lead to breaches, soft to alerts.
LimitType *string `mandatory:"false" contributesTo:"query" name:"limitType"`
// Resource Name.
ResourceType *string `mandatory:"false" contributesTo:"query" name:"resourceType"`
// Service Name.
ServiceType *string `mandatory:"false" contributesTo:"query" name:"serviceType"`
// 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 value of the 'opc-next-page' response header from the previous call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in the paginated response.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, which can be ascending (ASC) or descending (DESC).
SortOrder ListUsageLimitsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Supports one sort order.
SortBy ListUsageLimitsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListUsageLimitsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListUsageLimitsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListUsageLimitsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListUsageLimitsRequest) String() string
func (request ListUsageLimitsRequest) 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
ListUsageLimitsResponse wrapper for the ListUsageLimits operation
type ListUsageLimitsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of UsageLimitCollection instances
UsageLimitCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListUsageLimitsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListUsageLimitsResponse) String() string
ListUsageLimitsSortByEnum Enum with underlying type: string
type ListUsageLimitsSortByEnum string
Set of constants representing the allowable values for ListUsageLimitsSortByEnum
const (
ListUsageLimitsSortByTimecreated ListUsageLimitsSortByEnum = "TIMECREATED"
ListUsageLimitsSortByTimestart ListUsageLimitsSortByEnum = "TIMESTART"
)
func GetListUsageLimitsSortByEnumValues() []ListUsageLimitsSortByEnum
GetListUsageLimitsSortByEnumValues Enumerates the set of values for ListUsageLimitsSortByEnum
func GetMappingListUsageLimitsSortByEnum(val string) (ListUsageLimitsSortByEnum, bool)
GetMappingListUsageLimitsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListUsageLimitsSortOrderEnum Enum with underlying type: string
type ListUsageLimitsSortOrderEnum string
Set of constants representing the allowable values for ListUsageLimitsSortOrderEnum
const (
ListUsageLimitsSortOrderAsc ListUsageLimitsSortOrderEnum = "ASC"
ListUsageLimitsSortOrderDesc ListUsageLimitsSortOrderEnum = "DESC"
)
func GetListUsageLimitsSortOrderEnumValues() []ListUsageLimitsSortOrderEnum
GetListUsageLimitsSortOrderEnumValues Enumerates the set of values for ListUsageLimitsSortOrderEnum
func GetMappingListUsageLimitsSortOrderEnum(val string) (ListUsageLimitsSortOrderEnum, bool)
GetMappingListUsageLimitsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
MonthlyRewardSummary Object describing the monthly rewards summary for the requested subscription ID.
type MonthlyRewardSummary struct {
// The number of rewards available for a specific usage period.
AvailableRewards *float32 `mandatory:"false" json:"availableRewards"`
// The number of rewards redeemed for a specific month.
RedeemedRewards *float32 `mandatory:"false" json:"redeemedRewards"`
// The number of rewards earned for the specific usage period.
EarnedRewards *float32 `mandatory:"false" json:"earnedRewards"`
// The boolean parameter to indicate whether or not the available rewards are manually posted.
IsManual *bool `mandatory:"false" json:"isManual"`
// The date and time when rewards expire.
TimeRewardsExpired *common.SDKTime `mandatory:"false" json:"timeRewardsExpired"`
// The date and time when rewards accrue.
TimeRewardsEarned *common.SDKTime `mandatory:"false" json:"timeRewardsEarned"`
// The start date and time for the usage period.
TimeUsageStarted *common.SDKTime `mandatory:"false" json:"timeUsageStarted"`
// The end date and time for the usage period.
TimeUsageEnded *common.SDKTime `mandatory:"false" json:"timeUsageEnded"`
// The usage amount for the usage period.
UsageAmount *float64 `mandatory:"false" json:"usageAmount"`
// The eligible usage amount for the usage period.
EligibleUsageAmount *float64 `mandatory:"false" json:"eligibleUsageAmount"`
// The ineligible usage amount for the usage period.
IneligibleUsageAmount *float64 `mandatory:"false" json:"ineligibleUsageAmount"`
// The usage period ID.
UsagePeriodKey *string `mandatory:"false" json:"usagePeriodKey"`
}
func (m MonthlyRewardSummary) String() string
func (m MonthlyRewardSummary) 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
ProductCollection A product list.
type ProductCollection struct {
// The list of product rewards summaries.
Items []ProductSummary `mandatory:"true" json:"items"`
}
func (m ProductCollection) String() string
func (m ProductCollection) 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
ProductSummary Provides details about product rewards and the usage amount.
type ProductSummary struct {
// The rate card product number.
ProductNumber *string `mandatory:"false" json:"productNumber"`
// The rate card product name.
ProductName *string `mandatory:"false" json:"productName"`
// The rate card product usage amount.
UsageAmount *float64 `mandatory:"false" json:"usageAmount"`
// The earned rewards for the product.
EarnedRewards *float32 `mandatory:"false" json:"earnedRewards"`
// The boolean parameter to indicate if the product is eligible to earn rewards.
IsEligibleToEarnRewards *bool `mandatory:"false" json:"isEligibleToEarnRewards"`
}
func (m ProductSummary) String() string
func (m ProductSummary) 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
RedeemableUser The summary of a user that can redeem rewards.
type RedeemableUser struct {
// The email ID for a user that can redeem rewards.
EmailId *string `mandatory:"true" json:"emailId"`
// The first name of the user that can redeem rewards.
FirstName *string `mandatory:"false" json:"firstName"`
// The last name of the user that can redeem rewards.
LastName *string `mandatory:"false" json:"lastName"`
}
func (m RedeemableUser) String() string
func (m RedeemableUser) 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
RedeemableUserCollection The list of user summary that can redeem rewards.
type RedeemableUserCollection struct {
// The list of user summary that can redeem rewards.
Items []RedeemableUserSummary `mandatory:"true" json:"items"`
}
func (m RedeemableUserCollection) String() string
func (m RedeemableUserCollection) 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
RedeemableUserSummary User summary that can redeem rewards.
type RedeemableUserSummary struct {
// The email ID of the user that can redeem rewards.
EmailId *string `mandatory:"false" json:"emailId"`
// The first name of the user that can redeem rewards.
FirstName *string `mandatory:"false" json:"firstName"`
// The last name of the user that can redeem rewards.
LastName *string `mandatory:"false" json:"lastName"`
}
func (m RedeemableUserSummary) String() string
func (m RedeemableUserSummary) 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
RedemptionCollection The list of redemption summary for the requested subscription ID and date range.
type RedemptionCollection struct {
// The list of redemption summary.
Items []RedemptionSummary `mandatory:"true" json:"items"`
}
func (m RedemptionCollection) String() string
func (m RedemptionCollection) 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
RedemptionSummary The redemption summary for the requested subscription ID and date range.
type RedemptionSummary struct {
// It provides redeem date.
TimeRedeemed *common.SDKTime `mandatory:"false" json:"timeRedeemed"`
// It provides the redemption email id.
RedemptionEmail *string `mandatory:"false" json:"redemptionEmail"`
// The redemption code used in the Billing Center during the reward redemption process.
RedemptionCode *string `mandatory:"false" json:"redemptionCode"`
// It provides the invoice number against the redemption.
InvoiceNumber *string `mandatory:"false" json:"invoiceNumber"`
// It provides the invoice total amount of given redemption.
InvoiceTotalAmount *float64 `mandatory:"false" json:"invoiceTotalAmount"`
// The currency associated with invoice.
InvoiceCurrency *string `mandatory:"false" json:"invoiceCurrency"`
// It provides the redeemed rewards in invoice currency.
RedeemedRewards *float32 `mandatory:"false" json:"redeemedRewards"`
// It provides the redeemed rewards in base/subscription currency.
BaseRewards *float32 `mandatory:"false" json:"baseRewards"`
// It provides the fxRate between invoice currency and subscription currency.
FxRate *float64 `mandatory:"false" json:"fxRate"`
// It provides the invoice date.
TimeInvoiced *common.SDKTime `mandatory:"false" json:"timeInvoiced"`
}
func (m RedemptionSummary) String() string
func (m RedemptionSummary) 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
ResourceQuotumCollection The quota details of resources under a tenancy.
type ResourceQuotumCollection struct {
// The list of resource quota details.
Items []ResourceQuotumSummary `mandatory:"true" json:"items"`
// Used to indicate if further quota consumption isAllowed.
IsAllowed *bool `mandatory:"true" json:"isAllowed"`
}
func (m ResourceQuotumCollection) String() string
func (m ResourceQuotumCollection) 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
ResourceQuotumSummary The resource quota balance details.
type ResourceQuotumSummary struct {
// The resource name.
Name *string `mandatory:"false" json:"name"`
// Used to indicate if further quota consumption isAllowed.
IsAllowed *bool `mandatory:"false" json:"isAllowed"`
// The quota limit.
Limit *float64 `mandatory:"false" json:"limit"`
// The quota balance.
Balance *float64 `mandatory:"false" json:"balance"`
// Used to indicate if overages are incurred.
IsOverage *bool `mandatory:"false" json:"isOverage"`
// The purchased quota limit.
PurchasedLimit *float64 `mandatory:"false" json:"purchasedLimit"`
// The service name.
Service *string `mandatory:"false" json:"service"`
// Used to indicate any resource dependencies.
IsDependency *bool `mandatory:"false" json:"isDependency"`
// The affected resource name.
AffectedResource *string `mandatory:"false" json:"affectedResource"`
}
func (m ResourceQuotumSummary) String() string
func (m ResourceQuotumSummary) 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
ResourceSummary The details of a resource under a service.
type ResourceSummary struct {
// Units to be used for daily aggregated data.
DailyUnitDisplayName *string `mandatory:"false" json:"dailyUnitDisplayName"`
// Units to be used for hourly aggregated data.
HourlyUnitDisplayName *string `mandatory:"false" json:"hourlyUnitDisplayName"`
// Default units to use when unspecified.
RawUnitDisplayName *string `mandatory:"false" json:"rawUnitDisplayName"`
// Usage data type of the resource.
UsageDataType ResourceSummaryUsageDataTypeEnum `mandatory:"false" json:"usageDataType,omitempty"`
// Name of the resource.
Name *string `mandatory:"false" json:"name"`
// Name of the service.
Servicename *string `mandatory:"false" json:"servicename"`
// Description of the resource.
Description *string `mandatory:"false" json:"description"`
// Instance type for the resource.
InstanceType *string `mandatory:"false" json:"instanceType"`
// Indicates if the SKU was purchased
IsPurchased *bool `mandatory:"false" json:"isPurchased"`
// The details of any child resources.
ChildResources []string `mandatory:"false" json:"childResources"`
// The details of resource Skus.
Skus []SkuProducts `mandatory:"false" json:"skus"`
}
func (m ResourceSummary) String() string
func (m ResourceSummary) 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
ResourceSummaryUsageDataTypeEnum Enum with underlying type: string
type ResourceSummaryUsageDataTypeEnum string
Set of constants representing the allowable values for ResourceSummaryUsageDataTypeEnum
const (
ResourceSummaryUsageDataTypeInterval ResourceSummaryUsageDataTypeEnum = "INTERVAL"
ResourceSummaryUsageDataTypePointData ResourceSummaryUsageDataTypeEnum = "POINT_DATA"
)
func GetMappingResourceSummaryUsageDataTypeEnum(val string) (ResourceSummaryUsageDataTypeEnum, bool)
GetMappingResourceSummaryUsageDataTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResourceSummaryUsageDataTypeEnumValues() []ResourceSummaryUsageDataTypeEnum
GetResourceSummaryUsageDataTypeEnumValues Enumerates the set of values for ResourceSummaryUsageDataTypeEnum
ResourcesClient a client for Resources
type ResourcesClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewResourcesClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ResourcesClient, err error)
NewResourcesClientWithConfigurationProvider Creates a new default Resources client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewResourcesClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ResourcesClient, err error)
NewResourcesClientWithOboToken Creates a new default Resources client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *ResourcesClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ResourcesClient) ListResourceQuota(ctx context.Context, request ListResourceQuotaRequest) (response ListResourceQuotaResponse, err error)
ListResourceQuota Returns the resource quota details under a tenancy > **Important**: Calls to this API will only succeed against the endpoint in the home region.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListResourceQuota.go.html to see an example of how to use ListResourceQuota API. A default retry strategy applies to this operation ListResourceQuota()
func (client ResourcesClient) ListResources(ctx context.Context, request ListResourcesRequest) (response ListResourcesResponse, err error)
ListResources Returns the resource details for a service > **Important**: Calls to this API will only succeed against the endpoint in the home region.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListResources.go.html to see an example of how to use ListResources API. A default retry strategy applies to this operation ListResources()
func (client *ResourcesClient) SetRegion(region string)
SetRegion overrides the region of this client.
ResourcesCollection The resources of a service.
type ResourcesCollection struct {
// The list of resource details for a service.
Items []ResourceSummary `mandatory:"true" json:"items"`
}
func (m ResourcesCollection) String() string
func (m ResourcesCollection) 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
RewardCollection The response object for the ListRewards API call. Provides information about the subscription rewards.
type RewardCollection struct {
Summary *RewardDetails `mandatory:"true" json:"summary"`
// The monthly summary of rewards.
Items []MonthlyRewardSummary `mandatory:"false" json:"items"`
}
func (m RewardCollection) String() string
func (m RewardCollection) 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
RewardDetails The overall monthly reward summary.
type RewardDetails struct {
// The OCID of the target tenancy.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The entitlement ID from MQS, which is the same as the subcription ID.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// The currency unit for the reward amount.
Currency *string `mandatory:"false" json:"currency"`
// The current Rewards percentage in decimal format.
RewardsRate *float64 `mandatory:"false" json:"rewardsRate"`
// The total number of available rewards for a given subscription ID.
TotalRewardsAvailable *float32 `mandatory:"false" json:"totalRewardsAvailable"`
// The redemption code used in the Billing Center during the reward redemption process.
RedemptionCode *string `mandatory:"false" json:"redemptionCode"`
}
func (m RewardDetails) String() string
func (m RewardDetails) 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
RewardsClient a client for Rewards
type RewardsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewRewardsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RewardsClient, err error)
NewRewardsClientWithConfigurationProvider Creates a new default Rewards client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewRewardsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RewardsClient, err error)
NewRewardsClientWithOboToken Creates a new default Rewards client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *RewardsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client RewardsClient) CreateRedeemableUser(ctx context.Context, request CreateRedeemableUserRequest) (response CreateRedeemableUserResponse, err error)
CreateRedeemableUser Adds the list of redeemable user summary for a subscription ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/CreateRedeemableUser.go.html to see an example of how to use CreateRedeemableUser API.
func (client RewardsClient) DeleteRedeemableUser(ctx context.Context, request DeleteRedeemableUserRequest) (response DeleteRedeemableUserResponse, err error)
DeleteRedeemableUser Deletes the list of redeemable user email ID for a subscription ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/DeleteRedeemableUser.go.html to see an example of how to use DeleteRedeemableUser API.
func (client RewardsClient) ListProducts(ctx context.Context, request ListProductsRequest) (response ListProductsResponse, err error)
ListProducts Provides product information that is specific to a reward usage period and its usage details.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListProducts.go.html to see an example of how to use ListProducts API.
func (client RewardsClient) ListRedeemableUsers(ctx context.Context, request ListRedeemableUsersRequest) (response ListRedeemableUsersResponse, err error)
ListRedeemableUsers Provides the list of user summary that can redeem rewards for the given subscription ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListRedeemableUsers.go.html to see an example of how to use ListRedeemableUsers API.
func (client RewardsClient) ListRedemptions(ctx context.Context, request ListRedemptionsRequest) (response ListRedemptionsResponse, err error)
ListRedemptions Returns the list of redemption for the subscription ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListRedemptions.go.html to see an example of how to use ListRedemptions API.
func (client RewardsClient) ListRewards(ctx context.Context, request ListRewardsRequest) (response ListRewardsResponse, err error)
ListRewards Returns the list of rewards for a subscription ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListRewards.go.html to see an example of how to use ListRewards API.
func (client *RewardsClient) SetRegion(region string)
SetRegion overrides the region of this client.
SkuProducts The SKU Product Id details for a resource.
type SkuProducts struct {
// The Sku Id for the resource.
SkuId *string `mandatory:"false" json:"skuId"`
// The Sku type for the resource.
SkuType *string `mandatory:"false" json:"skuType"`
// The cloud credit type for the resource.
CloudCreditType *string `mandatory:"false" json:"cloudCreditType"`
}
func (m SkuProducts) String() string
func (m SkuProducts) 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
UsageLimitCollection The list of usage limit summary for the requested tenancy ID and subscription ID.
type UsageLimitCollection struct {
// The list of usage limits.
Items []UsageLimitSummary `mandatory:"true" json:"items"`
}
func (m UsageLimitCollection) String() string
func (m UsageLimitCollection) 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
UsageLimitSummary Encapsulates a collection of Hard and Soft Limits for a resource within a subscription.
type UsageLimitSummary struct {
// Time when the usage limit was created
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Entitlement ID of the usage limit
EntitlementId *string `mandatory:"true" json:"entitlementId"`
// The usage limit ID
Id *string `mandatory:"true" json:"id"`
// Time when the usage limit was modified
TimeModified *common.SDKTime `mandatory:"true" json:"timeModified"`
// The resource for which the limit is defined
ResourceName *string `mandatory:"true" json:"resourceName"`
// The service for which the limit is defined
ServiceName *string `mandatory:"true" json:"serviceName"`
// The limit value
Limit *string `mandatory:"true" json:"limit"`
// The user who created the limit
CreatedBy *string `mandatory:"true" json:"createdBy"`
// The user who modified the limit
ModifiedBy *string `mandatory:"true" json:"modifiedBy"`
// The action when usage limit is hit
Action UsageLimitSummaryActionEnum `mandatory:"true" json:"action"`
// The alert level of the usage limit
AlertLevel *float32 `mandatory:"true" json:"alertLevel"`
// The limit type of the usage limit
LimitType UsageLimitSummaryLimitTypeEnum `mandatory:"true" json:"limitType"`
// The value type of the usage limit
ValueType UsageLimitSummaryValueTypeEnum `mandatory:"true" json:"valueType"`
// The usage limit lifecycle state.
LifecycleState UsageLimitSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The maximum hard limit set for the usage limit
MaxHardLimit *string `mandatory:"false" json:"maxHardLimit"`
// The SKU for which the usage limit is set
SkuPartId *string `mandatory:"false" json:"skuPartId"`
}
func (m UsageLimitSummary) String() string
func (m UsageLimitSummary) 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
UsageLimitSummaryActionEnum Enum with underlying type: string
type UsageLimitSummaryActionEnum string
Set of constants representing the allowable values for UsageLimitSummaryActionEnum
const (
UsageLimitSummaryActionBreach UsageLimitSummaryActionEnum = "QUOTA_BREACH"
UsageLimitSummaryActionAlert UsageLimitSummaryActionEnum = "QUOTA_ALERT"
)
func GetMappingUsageLimitSummaryActionEnum(val string) (UsageLimitSummaryActionEnum, bool)
GetMappingUsageLimitSummaryActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUsageLimitSummaryActionEnumValues() []UsageLimitSummaryActionEnum
GetUsageLimitSummaryActionEnumValues Enumerates the set of values for UsageLimitSummaryActionEnum
UsageLimitSummaryLifecycleStateEnum Enum with underlying type: string
type UsageLimitSummaryLifecycleStateEnum string
Set of constants representing the allowable values for UsageLimitSummaryLifecycleStateEnum
const (
UsageLimitSummaryLifecycleStateActive UsageLimitSummaryLifecycleStateEnum = "ACTIVE"
)
func GetMappingUsageLimitSummaryLifecycleStateEnum(val string) (UsageLimitSummaryLifecycleStateEnum, bool)
GetMappingUsageLimitSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUsageLimitSummaryLifecycleStateEnumValues() []UsageLimitSummaryLifecycleStateEnum
GetUsageLimitSummaryLifecycleStateEnumValues Enumerates the set of values for UsageLimitSummaryLifecycleStateEnum
UsageLimitSummaryLimitTypeEnum Enum with underlying type: string
type UsageLimitSummaryLimitTypeEnum string
Set of constants representing the allowable values for UsageLimitSummaryLimitTypeEnum
const (
UsageLimitSummaryLimitTypeHard UsageLimitSummaryLimitTypeEnum = "HARD"
UsageLimitSummaryLimitTypeSoft UsageLimitSummaryLimitTypeEnum = "SOFT"
)
func GetMappingUsageLimitSummaryLimitTypeEnum(val string) (UsageLimitSummaryLimitTypeEnum, bool)
GetMappingUsageLimitSummaryLimitTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUsageLimitSummaryLimitTypeEnumValues() []UsageLimitSummaryLimitTypeEnum
GetUsageLimitSummaryLimitTypeEnumValues Enumerates the set of values for UsageLimitSummaryLimitTypeEnum
UsageLimitSummaryValueTypeEnum Enum with underlying type: string
type UsageLimitSummaryValueTypeEnum string
Set of constants representing the allowable values for UsageLimitSummaryValueTypeEnum
const (
UsageLimitSummaryValueTypeAbsolute UsageLimitSummaryValueTypeEnum = "ABSOLUTE"
UsageLimitSummaryValueTypePercentage UsageLimitSummaryValueTypeEnum = "PERCENTAGE"
)
func GetMappingUsageLimitSummaryValueTypeEnum(val string) (UsageLimitSummaryValueTypeEnum, bool)
GetMappingUsageLimitSummaryValueTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUsageLimitSummaryValueTypeEnumValues() []UsageLimitSummaryValueTypeEnum
GetUsageLimitSummaryValueTypeEnumValues Enumerates the set of values for UsageLimitSummaryValueTypeEnum
UsagelimitsClient a client for Usagelimits
type UsagelimitsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewUsagelimitsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client UsagelimitsClient, err error)
NewUsagelimitsClientWithConfigurationProvider Creates a new default Usagelimits client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewUsagelimitsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client UsagelimitsClient, err error)
NewUsagelimitsClientWithOboToken Creates a new default Usagelimits client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *UsagelimitsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client UsagelimitsClient) ListUsageLimits(ctx context.Context, request ListUsageLimitsRequest) (response ListUsageLimitsResponse, err error)
ListUsageLimits Returns the list of usage limit for the subscription ID and tenant ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/usage/ListUsageLimits.go.html to see an example of how to use ListUsageLimits API. A default retry strategy applies to this operation ListUsageLimits()
func (client *UsagelimitsClient) SetRegion(region string)
SetRegion overrides the region of this client.