usage

package
v57.0.0 Latest Latest
Warning

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

 Go to latest Published: Feb 8, 2022 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetListProductsProducttypeEnumStringValues 

func GetListProductsProducttypeEnumStringValues() []string

GetListProductsProducttypeEnumStringValues Enumerates the set of values in String for ListProductsProducttypeEnum

func GetListProductsSortByEnumStringValues 

func GetListProductsSortByEnumStringValues() []string

GetListProductsSortByEnumStringValues Enumerates the set of values in String for ListProductsSortByEnum

func GetListProductsSortOrderEnumStringValues 

func GetListProductsSortOrderEnumStringValues() []string

GetListProductsSortOrderEnumStringValues Enumerates the set of values in String for ListProductsSortOrderEnum

func GetListRedeemableUsersSortByEnumStringValues 

func GetListRedeemableUsersSortByEnumStringValues() []string

GetListRedeemableUsersSortByEnumStringValues Enumerates the set of values in String for ListRedeemableUsersSortByEnum

func GetListRedeemableUsersSortOrderEnumStringValues 

func GetListRedeemableUsersSortOrderEnumStringValues() []string

GetListRedeemableUsersSortOrderEnumStringValues Enumerates the set of values in String for ListRedeemableUsersSortOrderEnum

Types

type CreateRedeemableUserDetails 

type CreateRedeemableUserDetails struct {

	// The list of email ids to be added to the redeemable users list.
	Items []RedeemableUser `mandatory:"false" json:"items"`
}

CreateRedeemableUserDetails It contains a list of email Ids to be added to the redeemable users.

func (CreateRedeemableUserDetails) String 

func (m CreateRedeemableUserDetails) String() string

func (CreateRedeemableUserDetails) ValidateEnumValue 

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

type CreateRedeemableUserRequest 

type CreateRedeemableUserRequest struct {

	// CreateRedeemableUserDetails inforamtion.
	CreateRedeemableUserDetails `contributesTo:"body"`

	// The OCID of the tenancy.
	TenancyId *string `mandatory:"true" contributesTo:"query" name:"tenancyId"`

	// The subscriptionId for which rewards information is requested for.
	SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

	// The user Id of the person whose email we cc
	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
}

CreateRedeemableUserRequest wrapper for the CreateRedeemableUser operation

See also

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

func (CreateRedeemableUserRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateRedeemableUserRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateRedeemableUserRequest) RetryPolicy 

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

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

func (CreateRedeemableUserRequest) String 

func (request CreateRedeemableUserRequest) String() string

func (CreateRedeemableUserRequest) ValidateEnumValue 

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

type CreateRedeemableUserResponse 

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

CreateRedeemableUserResponse wrapper for the CreateRedeemableUser operation

func (CreateRedeemableUserResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateRedeemableUserResponse) String 

func (response CreateRedeemableUserResponse) String() string

type DeleteRedeemableUserRequest 

type DeleteRedeemableUserRequest struct {

	// The EmailId 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 subscriptionId 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
}

DeleteRedeemableUserRequest wrapper for the DeleteRedeemableUser operation

See also

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

func (DeleteRedeemableUserRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteRedeemableUserRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteRedeemableUserRequest) RetryPolicy 

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

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

func (DeleteRedeemableUserRequest) String 

func (request DeleteRedeemableUserRequest) String() string

func (DeleteRedeemableUserRequest) ValidateEnumValue 

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

type DeleteRedeemableUserResponse 

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

DeleteRedeemableUserResponse wrapper for the DeleteRedeemableUser operation

func (DeleteRedeemableUserResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteRedeemableUserResponse) String 

func (response DeleteRedeemableUserResponse) String() string

type ListProductsProducttypeEnum 

type ListProductsProducttypeEnum string

ListProductsProducttypeEnum Enum with underlying type: string 

const (
	ListProductsProducttypeAll        ListProductsProducttypeEnum = "ALL"
	ListProductsProducttypeEligible   ListProductsProducttypeEnum = "ELIGIBLE"
	ListProductsProducttypeIneligible ListProductsProducttypeEnum = "INELIGIBLE"
)

Set of constants representing the allowable values for ListProductsProducttypeEnum

func GetListProductsProducttypeEnumValues 

func GetListProductsProducttypeEnumValues() []ListProductsProducttypeEnum

GetListProductsProducttypeEnumValues Enumerates the set of values for ListProductsProducttypeEnum

type ListProductsRequest 

type ListProductsRequest struct {

	// The OCID of the tenancy.
	TenancyId *string `mandatory:"true" contributesTo:"query" name:"tenancyId"`

	// The subscriptionId 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, 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
}

ListProductsRequest wrapper for the ListProducts operation

See also

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

func (ListProductsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListProductsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListProductsRequest) RetryPolicy 

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

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

func (ListProductsRequest) String 

func (request ListProductsRequest) String() string

func (ListProductsRequest) ValidateEnumValue 

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

type ListProductsResponse 

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

ListProductsResponse wrapper for the ListProducts operation

func (ListProductsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListProductsResponse) String 

func (response ListProductsResponse) String() string

type ListProductsSortByEnum 

type ListProductsSortByEnum string

ListProductsSortByEnum Enum with underlying type: string 

const (
	ListProductsSortByTimecreated ListProductsSortByEnum = "TIMECREATED"
	ListProductsSortByTimestart   ListProductsSortByEnum = "TIMESTART"
)

Set of constants representing the allowable values for ListProductsSortByEnum

func GetListProductsSortByEnumValues 

func GetListProductsSortByEnumValues() []ListProductsSortByEnum

GetListProductsSortByEnumValues Enumerates the set of values for ListProductsSortByEnum

type ListProductsSortOrderEnum 

type ListProductsSortOrderEnum string

ListProductsSortOrderEnum Enum with underlying type: string 

const (
	ListProductsSortOrderAsc  ListProductsSortOrderEnum = "ASC"
	ListProductsSortOrderDesc ListProductsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListProductsSortOrderEnum

func GetListProductsSortOrderEnumValues 

func GetListProductsSortOrderEnumValues() []ListProductsSortOrderEnum

GetListProductsSortOrderEnumValues Enumerates the set of values for ListProductsSortOrderEnum

type ListRedeemableUsersRequest 

type ListRedeemableUsersRequest struct {

	// The OCID of the tenancy.
	TenancyId *string `mandatory:"true" contributesTo:"query" name:"tenancyId"`

	// The subscriptionId 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, 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
}

ListRedeemableUsersRequest wrapper for the ListRedeemableUsers operation

See also

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

func (ListRedeemableUsersRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListRedeemableUsersRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListRedeemableUsersRequest) RetryPolicy 

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

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

func (ListRedeemableUsersRequest) String 

func (request ListRedeemableUsersRequest) String() string

func (ListRedeemableUsersRequest) ValidateEnumValue 

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

type ListRedeemableUsersResponse 

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 optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

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

ListRedeemableUsersResponse wrapper for the ListRedeemableUsers operation

func (ListRedeemableUsersResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListRedeemableUsersResponse) String 

func (response ListRedeemableUsersResponse) String() string

type ListRedeemableUsersSortByEnum 

type ListRedeemableUsersSortByEnum string

ListRedeemableUsersSortByEnum Enum with underlying type: string 

const (
	ListRedeemableUsersSortByTimecreated ListRedeemableUsersSortByEnum = "TIMECREATED"
	ListRedeemableUsersSortByTimestart   ListRedeemableUsersSortByEnum = "TIMESTART"
)

Set of constants representing the allowable values for ListRedeemableUsersSortByEnum

func GetListRedeemableUsersSortByEnumValues 

func GetListRedeemableUsersSortByEnumValues() []ListRedeemableUsersSortByEnum

GetListRedeemableUsersSortByEnumValues Enumerates the set of values for ListRedeemableUsersSortByEnum

type ListRedeemableUsersSortOrderEnum 

type ListRedeemableUsersSortOrderEnum string

ListRedeemableUsersSortOrderEnum Enum with underlying type: string 

const (
	ListRedeemableUsersSortOrderAsc  ListRedeemableUsersSortOrderEnum = "ASC"
	ListRedeemableUsersSortOrderDesc ListRedeemableUsersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRedeemableUsersSortOrderEnum

func GetListRedeemableUsersSortOrderEnumValues 

func GetListRedeemableUsersSortOrderEnumValues() []ListRedeemableUsersSortOrderEnum

GetListRedeemableUsersSortOrderEnumValues Enumerates the set of values for ListRedeemableUsersSortOrderEnum

type ListRewardsRequest 

type ListRewardsRequest struct {

	// The OCID of the tenancy.
	TenancyId *string `mandatory:"true" contributesTo:"query" name:"tenancyId"`

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

ListRewardsRequest wrapper for the ListRewards operation

See also

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

func (ListRewardsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListRewardsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListRewardsRequest) RetryPolicy 

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

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

func (ListRewardsRequest) String 

func (request ListRewardsRequest) String() string

func (ListRewardsRequest) ValidateEnumValue 

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

type ListRewardsResponse 

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

ListRewardsResponse wrapper for the ListRewards operation

func (ListRewardsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListRewardsResponse) String 

func (response ListRewardsResponse) String() string

type MonthlyRewardSummary 

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 flag to tell if the available rewards are posted manually or not.
	IsManual *bool `mandatory:"false" json:"isManual"`

	// The date and time on which rewards are expired.
	TimeRewardsExpired *common.SDKTime `mandatory:"false" json:"timeRewardsExpired"`

	// The date and time on which rewards are accrued.
	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 in eligible usage amount for the usage period.
	IneligibleUsageAmount *float64 `mandatory:"false" json:"ineligibleUsageAmount"`

	// The id for the usage period.
	UsagePeriodKey *string `mandatory:"false" json:"usagePeriodKey"`
}

MonthlyRewardSummary Object describing the rewards summary for a month for the requested subscriptionId.

func (MonthlyRewardSummary) String 

func (m MonthlyRewardSummary) String() string

func (MonthlyRewardSummary) ValidateEnumValue 

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

type ProductCollection 

type ProductCollection struct {

	// The list of product rewards summaries.
	Items []ProductSummary `mandatory:"true" json:"items"`
}

ProductCollection A product list.

func (ProductCollection) String 

func (m ProductCollection) String() string

func (ProductCollection) ValidateEnumValue 

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

type ProductSummary 

type ProductSummary struct {

	// The ratecard product number.
	ProductNumber *string `mandatory:"false" json:"productNumber"`

	// The ratecard product Name.
	ProductName *string `mandatory:"false" json:"productName"`

	// The ratecard product usage amount.
	UsageAmount *float64 `mandatory:"false" json:"usageAmount"`

	// The earned rewards for the product.
	EarnedRewards *float32 `mandatory:"false" json:"earnedRewards"`

	// The boolean flag to tell if the product is eligible for earning rewards.
	IsEligibleToEarnRewards *bool `mandatory:"false" json:"isEligibleToEarnRewards"`
}

ProductSummary It provides details about a product rewards and usage amount.

func (ProductSummary) String 

func (m ProductSummary) String() string

func (ProductSummary) ValidateEnumValue 

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

type RedeemableUser 

type RedeemableUser struct {

	// The Email Id for redeemable user.
	EmailId *string `mandatory:"true" json:"emailId"`
}

RedeemableUser The Email object for redeemable user.

func (RedeemableUser) String 

func (m RedeemableUser) String() string

func (RedeemableUser) ValidateEnumValue 

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

type RedeemableUserCollection 

type RedeemableUserCollection struct {

	// The list of redeemable users email Ids.
	Items []RedeemableUserSummary `mandatory:"true" json:"items"`
}

RedeemableUserCollection It provides email Ids of redeemable users.

func (RedeemableUserCollection) String 

func (m RedeemableUserCollection) String() string

func (RedeemableUserCollection) ValidateEnumValue 

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

type RedeemableUserSummary 

type RedeemableUserSummary struct {

	// The email Id of Redeemable User.
	EmailId *string `mandatory:"false" json:"emailId"`
}

RedeemableUserSummary It provides email Id information.

func (RedeemableUserSummary) String 

func (m RedeemableUserSummary) String() string

func (RedeemableUserSummary) ValidateEnumValue 

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

type RewardCollection 

type RewardCollection struct {
	Summary *RewardDetails `mandatory:"true" json:"summary"`

	// The monthly summary of rewards.
	Items []MonthlyRewardSummary `mandatory:"false" json:"items"`
}

RewardCollection The response object for the ListRewards API call. It provides information about the rewards for a subscription.

func (RewardCollection) String 

func (m RewardCollection) String() string

func (RewardCollection) ValidateEnumValue 

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

type RewardDetails 

type RewardDetails struct {

	// The OCID of the target tenancy.
	TenancyId *string `mandatory:"false" json:"tenancyId"`

	// The entitlement id from MQS and it is same as 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"`
}

RewardDetails The overrall reward summary of the monthly summary rewards.

func (RewardDetails) String 

func (m RewardDetails) String() string

func (RewardDetails) ValidateEnumValue 

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

type RewardsClient 

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

RewardsClient a client for Rewards

func NewRewardsClientWithConfigurationProvider 

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 

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

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

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

func (RewardsClient) CreateRedeemableUser 

func (client RewardsClient) CreateRedeemableUser(ctx context.Context, request CreateRedeemableUserRequest) (response CreateRedeemableUserResponse, err error)

CreateRedeemableUser Add list of redeemable user email ids for a subscription Id

See also

Click https://docs.cloud.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 (RewardsClient) DeleteRedeemableUser 

func (client RewardsClient) DeleteRedeemableUser(ctx context.Context, request DeleteRedeemableUserRequest) (response DeleteRedeemableUserResponse, err error)

DeleteRedeemableUser Delete list of redeemable user email ids for a subscription Id

See also

Click https://docs.cloud.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 (RewardsClient) ListProducts 

func (client RewardsClient) ListProducts(ctx context.Context, request ListProductsRequest) (response ListProductsResponse, err error)

ListProducts This API provides usage period specific product and its usage details.

See also

Click https://docs.cloud.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 (RewardsClient) ListRedeemableUsers 

func (client RewardsClient) ListRedeemableUsers(ctx context.Context, request ListRedeemableUsersRequest) (response ListRedeemableUsersResponse, err error)

ListRedeemableUsers Provides emailids of redeemable users for the given subscriptionId

See also

Click https://docs.cloud.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 (RewardsClient) ListRewards 

func (client RewardsClient) ListRewards(ctx context.Context, request ListRewardsRequest) (response ListRewardsResponse, err error)

ListRewards This API returns list of rewards for a subscription Id

See also

Click https://docs.cloud.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 (*RewardsClient) SetRegion 

func (client *RewardsClient) SetRegion(region string)

SetRegion overrides the region of this client.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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