func GetListCommitmentsSortByEnumStringValues() []string
GetListCommitmentsSortByEnumStringValues Enumerates the set of values in String for ListCommitmentsSortByEnum
func GetListCommitmentsSortOrderEnumStringValues() []string
GetListCommitmentsSortOrderEnumStringValues Enumerates the set of values in String for ListCommitmentsSortOrderEnum
func GetListRateCardsSortByEnumStringValues() []string
GetListRateCardsSortByEnumStringValues Enumerates the set of values in String for ListRateCardsSortByEnum
func GetListRateCardsSortOrderEnumStringValues() []string
GetListRateCardsSortOrderEnumStringValues Enumerates the set of values in String for ListRateCardsSortOrderEnum
func GetListSubscriptionsSortByEnumStringValues() []string
GetListSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortByEnum
func GetListSubscriptionsSortOrderEnumStringValues() []string
GetListSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortOrderEnum
Commitment Subscribed service commitment details
type Commitment struct {
// Commitment start date
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Commitment end date
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Commitment quantity
Quantity *string `mandatory:"false" json:"quantity"`
// Commitment available amount
AvailableAmount *string `mandatory:"false" json:"availableAmount"`
// Commitment line net amount
LineNetAmount *string `mandatory:"false" json:"lineNetAmount"`
// Funded Allocation line value
FundedAllocationValue *string `mandatory:"false" json:"fundedAllocationValue"`
}
func (m Commitment) String() string
func (m Commitment) 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
CommitmentClient a client for Commitment
type CommitmentClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewCommitmentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client CommitmentClient, err error)
NewCommitmentClientWithConfigurationProvider Creates a new default Commitment client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewCommitmentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client CommitmentClient, err error)
NewCommitmentClientWithOboToken Creates a new default Commitment 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 *CommitmentClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client CommitmentClient) GetCommitment(ctx context.Context, request GetCommitmentRequest) (response GetCommitmentResponse, err error)
GetCommitment This API returns the commitment details corresponding to the id provided
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/osubsubscription/GetCommitment.go.html to see an example of how to use GetCommitment API.
func (client CommitmentClient) ListCommitments(ctx context.Context, request ListCommitmentsRequest) (response ListCommitmentsResponse, err error)
ListCommitments This list API returns all commitments for a particular Subscribed Service
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/osubsubscription/ListCommitments.go.html to see an example of how to use ListCommitments API.
func (client *CommitmentClient) SetRegion(region string)
SetRegion overrides the region of this client.
CommitmentDetail Subscribed Service commitment summary
type CommitmentDetail struct {
// SPM internal Commitment ID
Id *string `mandatory:"true" json:"id"`
// Commitment start date
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Commitment end date
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Commitment quantity
Quantity *string `mandatory:"false" json:"quantity"`
// Commitment used amount
UsedAmount *string `mandatory:"false" json:"usedAmount"`
// Commitment available amount
AvailableAmount *string `mandatory:"false" json:"availableAmount"`
// Funded Allocation line value
// example: 12000.00
FundedAllocationValue *string `mandatory:"false" json:"fundedAllocationValue"`
}
func (m CommitmentDetail) String() string
func (m CommitmentDetail) 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
CommitmentSummary Subscribed Service commitment summary
type CommitmentSummary struct {
// SPM internal Commitment ID
Id *string `mandatory:"true" json:"id"`
// Commitment start date
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Commitment end date
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Commitment quantity
Quantity *string `mandatory:"false" json:"quantity"`
// Commitment used amount
UsedAmount *string `mandatory:"false" json:"usedAmount"`
// Commitment available amount
AvailableAmount *string `mandatory:"false" json:"availableAmount"`
// Funded Allocation line value
// example: 12000.00
FundedAllocationValue *string `mandatory:"false" json:"fundedAllocationValue"`
}
func (m CommitmentSummary) String() string
func (m CommitmentSummary) 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
Currency Currency details
type Currency struct {
// Currency Code
IsoCode *string `mandatory:"true" json:"isoCode"`
// Currency name
Name *string `mandatory:"false" json:"name"`
// Standard Precision of the Currency
StdPrecision *int64 `mandatory:"false" json:"stdPrecision"`
}
func (m Currency) String() string
func (m Currency) 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
GetCommitmentRequest wrapper for the GetCommitment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/osubsubscription/GetCommitment.go.html to see an example of how to use GetCommitmentRequest.
type GetCommitmentRequest struct {
// The Commitment Id
CommitmentId *string `mandatory:"true" contributesTo:"path" name:"commitmentId"`
// 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"`
// This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is
// to help on Gateway to API calls identification.
XOneGatewaySubscriptionId *string `mandatory:"false" contributesTo:"header" name:"x-one-gateway-subscription-id"`
// The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
XOneOriginRegion *string `mandatory:"false" contributesTo:"header" name:"x-one-origin-region"`
// 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 GetCommitmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCommitmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCommitmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCommitmentRequest) String() string
func (request GetCommitmentRequest) 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
GetCommitmentResponse wrapper for the GetCommitment operation
type GetCommitmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The CommitmentDetail instance
CommitmentDetail `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 GetCommitmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCommitmentResponse) String() string
ListCommitmentsRequest wrapper for the ListCommitments operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/osubsubscription/ListCommitments.go.html to see an example of how to use ListCommitmentsRequest.
type ListCommitmentsRequest struct {
// This param is used to get the commitments for a particular subscribed service
SubscribedServiceId *string `mandatory:"true" contributesTo:"query" name:"subscribedServiceId"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListCommitmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
SortBy ListCommitmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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"`
// This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is
// to help on Gateway to API calls identification.
XOneGatewaySubscriptionId *string `mandatory:"false" contributesTo:"header" name:"x-one-gateway-subscription-id"`
// The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
XOneOriginRegion *string `mandatory:"false" contributesTo:"header" name:"x-one-origin-region"`
// 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 ListCommitmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCommitmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCommitmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCommitmentsRequest) String() string
func (request ListCommitmentsRequest) 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
ListCommitmentsResponse wrapper for the ListCommitments operation
type ListCommitmentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []CommitmentSummary instances
Items []CommitmentSummary `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 ListCommitmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCommitmentsResponse) String() string
ListCommitmentsSortByEnum Enum with underlying type: string
type ListCommitmentsSortByEnum string
Set of constants representing the allowable values for ListCommitmentsSortByEnum
const (
ListCommitmentsSortByTimecreated ListCommitmentsSortByEnum = "TIMECREATED"
ListCommitmentsSortByTimestart ListCommitmentsSortByEnum = "TIMESTART"
)
func GetListCommitmentsSortByEnumValues() []ListCommitmentsSortByEnum
GetListCommitmentsSortByEnumValues Enumerates the set of values for ListCommitmentsSortByEnum
func GetMappingListCommitmentsSortByEnum(val string) (ListCommitmentsSortByEnum, bool)
GetMappingListCommitmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCommitmentsSortOrderEnum Enum with underlying type: string
type ListCommitmentsSortOrderEnum string
Set of constants representing the allowable values for ListCommitmentsSortOrderEnum
const (
ListCommitmentsSortOrderAsc ListCommitmentsSortOrderEnum = "ASC"
ListCommitmentsSortOrderDesc ListCommitmentsSortOrderEnum = "DESC"
)
func GetListCommitmentsSortOrderEnumValues() []ListCommitmentsSortOrderEnum
GetListCommitmentsSortOrderEnumValues Enumerates the set of values for ListCommitmentsSortOrderEnum
func GetMappingListCommitmentsSortOrderEnum(val string) (ListCommitmentsSortOrderEnum, bool)
GetMappingListCommitmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRateCardsRequest wrapper for the ListRateCards operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/osubsubscription/ListRateCards.go.html to see an example of how to use ListRateCardsRequest.
type ListRateCardsRequest struct {
// Line level Subscription Id
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// This param is used to get the rate card(s) whose effective start date starts on or after a particular date
TimeFrom *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeFrom"`
// This param is used to get the rate card(s) whose effective end date ends on or before a particular date
TimeTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeTo"`
// This param is used to get the rate card(s) filterd by the partNumber
PartNumber *string `mandatory:"false" contributesTo:"query" name:"partNumber"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListRateCardsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
SortBy ListRateCardsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
XOneOriginRegion *string `mandatory:"false" contributesTo:"header" name:"x-one-origin-region"`
// 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 ListRateCardsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRateCardsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRateCardsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRateCardsRequest) String() string
func (request ListRateCardsRequest) 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
ListRateCardsResponse wrapper for the ListRateCards operation
type ListRateCardsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []RateCardSummary instances
Items []RateCardSummary `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 ListRateCardsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRateCardsResponse) String() string
ListRateCardsSortByEnum Enum with underlying type: string
type ListRateCardsSortByEnum string
Set of constants representing the allowable values for ListRateCardsSortByEnum
const (
ListRateCardsSortByTimecreated ListRateCardsSortByEnum = "TIMECREATED"
ListRateCardsSortByTimestart ListRateCardsSortByEnum = "TIMESTART"
)
func GetListRateCardsSortByEnumValues() []ListRateCardsSortByEnum
GetListRateCardsSortByEnumValues Enumerates the set of values for ListRateCardsSortByEnum
func GetMappingListRateCardsSortByEnum(val string) (ListRateCardsSortByEnum, bool)
GetMappingListRateCardsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRateCardsSortOrderEnum Enum with underlying type: string
type ListRateCardsSortOrderEnum string
Set of constants representing the allowable values for ListRateCardsSortOrderEnum
const (
ListRateCardsSortOrderAsc ListRateCardsSortOrderEnum = "ASC"
ListRateCardsSortOrderDesc ListRateCardsSortOrderEnum = "DESC"
)
func GetListRateCardsSortOrderEnumValues() []ListRateCardsSortOrderEnum
GetListRateCardsSortOrderEnumValues Enumerates the set of values for ListRateCardsSortOrderEnum
func GetMappingListRateCardsSortOrderEnum(val string) (ListRateCardsSortOrderEnum, bool)
GetMappingListRateCardsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionsRequest wrapper for the ListSubscriptions operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/osubsubscription/ListSubscriptions.go.html to see an example of how to use ListSubscriptionsRequest.
type ListSubscriptionsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The Plan Number
PlanNumber *string `mandatory:"false" contributesTo:"query" name:"planNumber"`
// Line level Subscription Id
SubscriptionId *string `mandatory:"false" contributesTo:"query" name:"subscriptionId"`
// Buyer Email Id
BuyerEmail *string `mandatory:"false" contributesTo:"query" name:"buyerEmail"`
// Boolean value to decide whether commitment services will be shown
IsCommitInfoRequired *bool `mandatory:"false" contributesTo:"query" name:"isCommitInfoRequired"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
SortBy ListSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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"`
// This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is
// to help on Gateway to API calls identification.
XOneGatewaySubscriptionId *string `mandatory:"false" contributesTo:"header" name:"x-one-gateway-subscription-id"`
// The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
XOneOriginRegion *string `mandatory:"false" contributesTo:"header" name:"x-one-origin-region"`
// 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 ListSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSubscriptionsRequest) String() string
func (request ListSubscriptionsRequest) 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
ListSubscriptionsResponse wrapper for the ListSubscriptions operation
type ListSubscriptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []SubscriptionSummary instances
Items []SubscriptionSummary `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 ListSubscriptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSubscriptionsResponse) String() string
ListSubscriptionsSortByEnum Enum with underlying type: string
type ListSubscriptionsSortByEnum string
Set of constants representing the allowable values for ListSubscriptionsSortByEnum
const (
ListSubscriptionsSortByTimecreated ListSubscriptionsSortByEnum = "TIMECREATED"
ListSubscriptionsSortByTimestart ListSubscriptionsSortByEnum = "TIMESTART"
)
func GetListSubscriptionsSortByEnumValues() []ListSubscriptionsSortByEnum
GetListSubscriptionsSortByEnumValues Enumerates the set of values for ListSubscriptionsSortByEnum
func GetMappingListSubscriptionsSortByEnum(val string) (ListSubscriptionsSortByEnum, bool)
GetMappingListSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionsSortOrderEnum Enum with underlying type: string
type ListSubscriptionsSortOrderEnum string
Set of constants representing the allowable values for ListSubscriptionsSortOrderEnum
const (
ListSubscriptionsSortOrderAsc ListSubscriptionsSortOrderEnum = "ASC"
ListSubscriptionsSortOrderDesc ListSubscriptionsSortOrderEnum = "DESC"
)
func GetListSubscriptionsSortOrderEnumValues() []ListSubscriptionsSortOrderEnum
GetListSubscriptionsSortOrderEnumValues Enumerates the set of values for ListSubscriptionsSortOrderEnum
func GetMappingListSubscriptionsSortOrderEnum(val string) (ListSubscriptionsSortOrderEnum, bool)
GetMappingListSubscriptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
Product Product description
type Product struct {
// Product part numner
PartNumber *string `mandatory:"true" json:"partNumber"`
// Product name
Name *string `mandatory:"true" json:"name"`
// Unit of measure
UnitOfMeasure *string `mandatory:"true" json:"unitOfMeasure"`
// Metered service billing category
BillingCategory *string `mandatory:"false" json:"billingCategory"`
// Product category
ProductCategory *string `mandatory:"false" json:"productCategory"`
// Rate card part type of Product
UcmRateCardPartType *string `mandatory:"false" json:"ucmRateCardPartType"`
}
func (m Product) String() string
func (m Product) 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
RateCardSummary Rate Card Summary
type RateCardSummary struct {
Product *Product `mandatory:"true" json:"product"`
// Rate card net unit price
NetUnitPrice *string `mandatory:"true" json:"netUnitPrice"`
// Rate card overage price
OveragePrice *string `mandatory:"true" json:"overagePrice"`
// Rate card start date
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Rate card end date
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Rate card discretionary discount percentage
DiscretionaryDiscountPercentage *string `mandatory:"false" json:"discretionaryDiscountPercentage"`
// Rate card price tier flag
IsTier *bool `mandatory:"false" json:"isTier"`
Currency *Currency `mandatory:"false" json:"currency"`
// List of tiered rate card prices
RateCardTiers []RateCardTier `mandatory:"false" json:"rateCardTiers"`
}
func (m RateCardSummary) String() string
func (m RateCardSummary) 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
RateCardTier Rate Card Tier details
type RateCardTier struct {
// Rate card tier quantity range
UpToQuantity *string `mandatory:"false" json:"upToQuantity"`
// Rate card tier net unit price
NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`
// Rate card tier overage price
OveragePrice *string `mandatory:"false" json:"overagePrice"`
}
func (m RateCardTier) String() string
func (m RateCardTier) 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
RatecardClient a client for Ratecard
type RatecardClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewRatecardClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RatecardClient, err error)
NewRatecardClientWithConfigurationProvider Creates a new default Ratecard client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewRatecardClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RatecardClient, err error)
NewRatecardClientWithOboToken Creates a new default Ratecard 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 *RatecardClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client RatecardClient) ListRateCards(ctx context.Context, request ListRateCardsRequest) (response ListRateCardsResponse, err error)
ListRateCards List API that returns all ratecards for given Subscription Id and Account ID (if provided) and for a particular date range
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/osubsubscription/ListRateCards.go.html to see an example of how to use ListRateCards API.
func (client *RatecardClient) SetRegion(region string)
SetRegion overrides the region of this client.
SubscribedServiceSummary Subscribed Service summary
type SubscribedServiceSummary struct {
// SPM internal Subscribed Service ID
Id *string `mandatory:"true" json:"id"`
Product *SubscriptionProduct `mandatory:"false" json:"product"`
// Subscribed service quantity
Quantity *string `mandatory:"false" json:"quantity"`
// Subscribed service status
Status *string `mandatory:"false" json:"status"`
// Subscribed service operation type
OperationType *string `mandatory:"false" json:"operationType"`
// Subscribed service net unit price
NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`
// Funded Allocation line value
// example: 12000.00
FundedAllocationValue *string `mandatory:"false" json:"fundedAllocationValue"`
// This field contains the name of the partner to which the subscription belongs - depending on which the invoicing may differ
PartnerTransactionType *string `mandatory:"false" json:"partnerTransactionType"`
// Term value in Months
TermValue *int64 `mandatory:"false" json:"termValue"`
// Term value UOM
TermValueUOM *string `mandatory:"false" json:"termValueUOM"`
// Booking Opportunity Number of Subscribed Service
BookingOptyNumber *string `mandatory:"false" json:"bookingOptyNumber"`
// Subscribed service total value
TotalValue *string `mandatory:"false" json:"totalValue"`
// Sales Order Number associated to the subscribed service
OrderNumber *int64 `mandatory:"false" json:"orderNumber"`
// Subscribed service data center region
DataCenterRegion *string `mandatory:"false" json:"dataCenterRegion"`
// Subscribed service pricing model
PricingModel *string `mandatory:"false" json:"pricingModel"`
// Subscribed service program type
ProgramType *string `mandatory:"false" json:"programType"`
// Subscribed service promotion type
PromoType *string `mandatory:"false" json:"promoType"`
// Subscribed service CSI number
Csi *int64 `mandatory:"false" json:"csi"`
// Subscribed service intent to pay flag
IsIntentToPay *bool `mandatory:"false" json:"isIntentToPay"`
// Subscribed service start date
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Subscribed service end date
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// List of Commitment services of a line
CommitmentServices []Commitment `mandatory:"false" json:"commitmentServices"`
}
func (m SubscribedServiceSummary) String() string
func (m SubscribedServiceSummary) 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
SubscriptionClient a client for Subscription
type SubscriptionClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewSubscriptionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SubscriptionClient, err error)
NewSubscriptionClientWithConfigurationProvider Creates a new default Subscription client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewSubscriptionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SubscriptionClient, err error)
NewSubscriptionClientWithOboToken Creates a new default Subscription 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 *SubscriptionClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client SubscriptionClient) ListSubscriptions(ctx context.Context, request ListSubscriptionsRequest) (response ListSubscriptionsResponse, err error)
ListSubscriptions This list API returns all subscriptions for a given plan number or subscription id or buyer email and provides additional parameters to include ratecard and commitment details. This API expects exactly one of the above mentioned parameters as input. If more than one parameters are provided the API will throw a 400 - invalid parameters exception and if no parameters are provided it will throw a 400 - missing parameter exception
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/osubsubscription/ListSubscriptions.go.html to see an example of how to use ListSubscriptions API.
func (client *SubscriptionClient) SetRegion(region string)
SetRegion overrides the region of this client.
SubscriptionProduct Product description
type SubscriptionProduct struct {
// Product part numner
PartNumber *string `mandatory:"true" json:"partNumber"`
// Product name
Name *string `mandatory:"true" json:"name"`
// Unit of measure
UnitOfMeasure *string `mandatory:"true" json:"unitOfMeasure"`
// Product provisioning group
ProvisioningGroup *string `mandatory:"false" json:"provisioningGroup"`
}
func (m SubscriptionProduct) String() string
func (m SubscriptionProduct) 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
SubscriptionSummary Subscription summary
type SubscriptionSummary struct {
// Status of the plan
Status *string `mandatory:"false" json:"status"`
// Represents the date when the first service of the subscription was activated
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Represents the date when the last service of the subscription ends
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
Currency *Currency `mandatory:"false" json:"currency"`
// Customer friendly service name provided by PRG
ServiceName *string `mandatory:"false" json:"serviceName"`
// List of Subscribed Services of the plan
SubscribedServices []SubscribedServiceSummary `mandatory:"false" json:"subscribedServices"`
}
func (m SubscriptionSummary) String() string
func (m SubscriptionSummary) 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