osubsubscription

package
v65.52.0 Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2023 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetListCommitmentsSortByEnumStringValues 

func GetListCommitmentsSortByEnumStringValues() []string

GetListCommitmentsSortByEnumStringValues Enumerates the set of values in String for ListCommitmentsSortByEnum

func GetListCommitmentsSortOrderEnumStringValues 

func GetListCommitmentsSortOrderEnumStringValues() []string

GetListCommitmentsSortOrderEnumStringValues Enumerates the set of values in String for ListCommitmentsSortOrderEnum

func GetListRateCardsSortByEnumStringValues 

func GetListRateCardsSortByEnumStringValues() []string

GetListRateCardsSortByEnumStringValues Enumerates the set of values in String for ListRateCardsSortByEnum

func GetListRateCardsSortOrderEnumStringValues 

func GetListRateCardsSortOrderEnumStringValues() []string

GetListRateCardsSortOrderEnumStringValues Enumerates the set of values in String for ListRateCardsSortOrderEnum

func GetListSubscriptionsSortByEnumStringValues 

func GetListSubscriptionsSortByEnumStringValues() []string

GetListSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortByEnum

func GetListSubscriptionsSortOrderEnumStringValues 

func GetListSubscriptionsSortOrderEnumStringValues() []string

GetListSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortOrderEnum

Types

type Commitment 

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

Commitment Subscribed service commitment details

func (Commitment) String 

func (m Commitment) String() string

func (Commitment) ValidateEnumValue 

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

type CommitmentClient 

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

CommitmentClient a client for Commitment

func NewCommitmentClientWithConfigurationProvider 

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 

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

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

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

func (CommitmentClient) GetCommitment 

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

func (CommitmentClient) ListCommitments 

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

func (*CommitmentClient) SetRegion 

func (client *CommitmentClient) SetRegion(region string)

SetRegion overrides the region of this client.

type CommitmentDetail 

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

CommitmentDetail Subscribed Service commitment summary

func (CommitmentDetail) String 

func (m CommitmentDetail) String() string

func (CommitmentDetail) ValidateEnumValue 

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

type CommitmentSummary 

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

CommitmentSummary Subscribed Service commitment summary

func (CommitmentSummary) String 

func (m CommitmentSummary) String() string

func (CommitmentSummary) ValidateEnumValue 

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

type Currency 

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

Currency Currency details

func (Currency) String 

func (m Currency) String() string

func (Currency) ValidateEnumValue 

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

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

GetCommitmentRequest wrapper for the GetCommitment operation

See also

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

func (GetCommitmentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetCommitmentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetCommitmentRequest) RetryPolicy 

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

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

func (GetCommitmentRequest) String 

func (request GetCommitmentRequest) String() string

func (GetCommitmentRequest) ValidateEnumValue 

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

type GetCommitmentResponse 

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

GetCommitmentResponse wrapper for the GetCommitment operation

func (GetCommitmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetCommitmentResponse) String 

func (response GetCommitmentResponse) String() string

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

ListCommitmentsRequest wrapper for the ListCommitments operation

See also

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

func (ListCommitmentsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListCommitmentsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListCommitmentsRequest) RetryPolicy 

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

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

func (ListCommitmentsRequest) String 

func (request ListCommitmentsRequest) String() string

func (ListCommitmentsRequest) ValidateEnumValue 

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

type ListCommitmentsResponse 

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

ListCommitmentsResponse wrapper for the ListCommitments operation

func (ListCommitmentsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListCommitmentsResponse) String 

func (response ListCommitmentsResponse) String() string

type ListCommitmentsSortByEnum 

type ListCommitmentsSortByEnum string

ListCommitmentsSortByEnum Enum with underlying type: string 

const (
	ListCommitmentsSortByTimecreated ListCommitmentsSortByEnum = "TIMECREATED"
	ListCommitmentsSortByTimestart   ListCommitmentsSortByEnum = "TIMESTART"
)

Set of constants representing the allowable values for ListCommitmentsSortByEnum

func GetListCommitmentsSortByEnumValues 

func GetListCommitmentsSortByEnumValues() []ListCommitmentsSortByEnum

GetListCommitmentsSortByEnumValues Enumerates the set of values for ListCommitmentsSortByEnum

func GetMappingListCommitmentsSortByEnum 

func GetMappingListCommitmentsSortByEnum(val string) (ListCommitmentsSortByEnum, bool)

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

type ListCommitmentsSortOrderEnum 

type ListCommitmentsSortOrderEnum string

ListCommitmentsSortOrderEnum Enum with underlying type: string 

const (
	ListCommitmentsSortOrderAsc  ListCommitmentsSortOrderEnum = "ASC"
	ListCommitmentsSortOrderDesc ListCommitmentsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListCommitmentsSortOrderEnum

func GetListCommitmentsSortOrderEnumValues 

func GetListCommitmentsSortOrderEnumValues() []ListCommitmentsSortOrderEnum

GetListCommitmentsSortOrderEnumValues Enumerates the set of values for ListCommitmentsSortOrderEnum

func GetMappingListCommitmentsSortOrderEnum 

func GetMappingListCommitmentsSortOrderEnum(val string) (ListCommitmentsSortOrderEnum, bool)

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

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

ListRateCardsRequest wrapper for the ListRateCards operation

See also

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

func (ListRateCardsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListRateCardsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListRateCardsRequest) RetryPolicy 

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

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

func (ListRateCardsRequest) String 

func (request ListRateCardsRequest) String() string

func (ListRateCardsRequest) ValidateEnumValue 

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

type ListRateCardsResponse 

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

ListRateCardsResponse wrapper for the ListRateCards operation

func (ListRateCardsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListRateCardsResponse) String 

func (response ListRateCardsResponse) String() string

type ListRateCardsSortByEnum 

type ListRateCardsSortByEnum string

ListRateCardsSortByEnum Enum with underlying type: string 

const (
	ListRateCardsSortByTimecreated ListRateCardsSortByEnum = "TIMECREATED"
	ListRateCardsSortByTimestart   ListRateCardsSortByEnum = "TIMESTART"
)

Set of constants representing the allowable values for ListRateCardsSortByEnum

func GetListRateCardsSortByEnumValues 

func GetListRateCardsSortByEnumValues() []ListRateCardsSortByEnum

GetListRateCardsSortByEnumValues Enumerates the set of values for ListRateCardsSortByEnum

func GetMappingListRateCardsSortByEnum 

func GetMappingListRateCardsSortByEnum(val string) (ListRateCardsSortByEnum, bool)

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

type ListRateCardsSortOrderEnum 

type ListRateCardsSortOrderEnum string

ListRateCardsSortOrderEnum Enum with underlying type: string 

const (
	ListRateCardsSortOrderAsc  ListRateCardsSortOrderEnum = "ASC"
	ListRateCardsSortOrderDesc ListRateCardsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRateCardsSortOrderEnum

func GetListRateCardsSortOrderEnumValues 

func GetListRateCardsSortOrderEnumValues() []ListRateCardsSortOrderEnum

GetListRateCardsSortOrderEnumValues Enumerates the set of values for ListRateCardsSortOrderEnum

func GetMappingListRateCardsSortOrderEnum 

func GetMappingListRateCardsSortOrderEnum(val string) (ListRateCardsSortOrderEnum, bool)

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

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

ListSubscriptionsRequest wrapper for the ListSubscriptions operation

See also

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

func (ListSubscriptionsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListSubscriptionsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListSubscriptionsRequest) RetryPolicy 

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

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

func (ListSubscriptionsRequest) String 

func (request ListSubscriptionsRequest) String() string

func (ListSubscriptionsRequest) ValidateEnumValue 

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

type ListSubscriptionsResponse 

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

ListSubscriptionsResponse wrapper for the ListSubscriptions operation

func (ListSubscriptionsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListSubscriptionsResponse) String 

func (response ListSubscriptionsResponse) String() string

type ListSubscriptionsSortByEnum 

type ListSubscriptionsSortByEnum string

ListSubscriptionsSortByEnum Enum with underlying type: string 

const (
	ListSubscriptionsSortByTimecreated ListSubscriptionsSortByEnum = "TIMECREATED"
	ListSubscriptionsSortByTimestart   ListSubscriptionsSortByEnum = "TIMESTART"
)

Set of constants representing the allowable values for ListSubscriptionsSortByEnum

func GetListSubscriptionsSortByEnumValues 

func GetListSubscriptionsSortByEnumValues() []ListSubscriptionsSortByEnum

GetListSubscriptionsSortByEnumValues Enumerates the set of values for ListSubscriptionsSortByEnum

func GetMappingListSubscriptionsSortByEnum 

func GetMappingListSubscriptionsSortByEnum(val string) (ListSubscriptionsSortByEnum, bool)

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

type ListSubscriptionsSortOrderEnum 

type ListSubscriptionsSortOrderEnum string

ListSubscriptionsSortOrderEnum Enum with underlying type: string 

const (
	ListSubscriptionsSortOrderAsc  ListSubscriptionsSortOrderEnum = "ASC"
	ListSubscriptionsSortOrderDesc ListSubscriptionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSubscriptionsSortOrderEnum

func GetListSubscriptionsSortOrderEnumValues 

func GetListSubscriptionsSortOrderEnumValues() []ListSubscriptionsSortOrderEnum

GetListSubscriptionsSortOrderEnumValues Enumerates the set of values for ListSubscriptionsSortOrderEnum

func GetMappingListSubscriptionsSortOrderEnum 

func GetMappingListSubscriptionsSortOrderEnum(val string) (ListSubscriptionsSortOrderEnum, bool)

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

type Product 

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

Product Product description

func (Product) String 

func (m Product) String() string

func (Product) ValidateEnumValue 

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

type RateCardSummary 

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

RateCardSummary Rate Card Summary

func (RateCardSummary) String 

func (m RateCardSummary) String() string

func (RateCardSummary) ValidateEnumValue 

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

type RateCardTier 

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

RateCardTier Rate Card Tier details

func (RateCardTier) String 

func (m RateCardTier) String() string

func (RateCardTier) ValidateEnumValue 

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

type RatecardClient 

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

RatecardClient a client for Ratecard

func NewRatecardClientWithConfigurationProvider 

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 

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

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

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

func (RatecardClient) ListRateCards 

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

func (*RatecardClient) SetRegion 

func (client *RatecardClient) SetRegion(region string)

SetRegion overrides the region of this client.

type SubscribedServiceSummary 

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

SubscribedServiceSummary Subscribed Service summary

func (SubscribedServiceSummary) String 

func (m SubscribedServiceSummary) String() string

func (SubscribedServiceSummary) ValidateEnumValue 

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

type SubscriptionClient 

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

SubscriptionClient a client for Subscription

func NewSubscriptionClientWithConfigurationProvider 

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 

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

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

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

func (SubscriptionClient) ListSubscriptions 

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

func (*SubscriptionClient) SetRegion 

func (client *SubscriptionClient) SetRegion(region string)

SetRegion overrides the region of this client.

type SubscriptionProduct 

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

SubscriptionProduct Product description

func (SubscriptionProduct) String 

func (m SubscriptionProduct) String() string

func (SubscriptionProduct) ValidateEnumValue 

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

type SubscriptionSummary 

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

SubscriptionSummary Subscription summary

func (SubscriptionSummary) String 

func (m SubscriptionSummary) String() string

func (SubscriptionSummary) ValidateEnumValue 

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

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.