...

Package self

import "github.com/oracle/oci-go-sdk/self"
Overview
Index

Overview ▾

Index ▾

func GetActionTypeEnumStringValues() []string
func GetBillingDetailsBillingModelEnumStringValues() []string
func GetBillingFrequencyEnumStringValues() []string
func GetCreateSubscriptionUsageRecordDetailsBillingTypeEnumStringValues() []string
func GetLifecycleDetailsEnumEnumStringValues() []string
func GetLifecycleStateEnumEnumStringValues() []string
func GetListPartnersSortByEnumStringValues() []string
func GetListPartnersSortOrderEnumStringValues() []string
func GetListSubscriptionsLifecycleDetailsEnumStringValues() []string
func GetListSubscriptionsSortByEnumStringValues() []string
func GetListSubscriptionsSortOrderEnumStringValues() []string
func GetListWorkRequestErrorsSortByEnumStringValues() []string
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
func GetListWorkRequestLogsSortByEnumStringValues() []string
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
func GetListWorkRequestsSortByEnumStringValues() []string
func GetListWorkRequestsSortOrderEnumStringValues() []string
func GetListWorkRequestsStatusEnumStringValues() []string
func GetListingSubscriptionsSortByEnumStringValues() []string
func GetListingSubscriptionsSortOrderEnumStringValues() []string
func GetMetricTypeEnumStringValues() []string
func GetOperationStatusEnumStringValues() []string
func GetOperationTypeEnumStringValues() []string
func GetPartnerLifecycleStateEnumStringValues() []string
func GetPricingPlanPlanDurationEnumStringValues() []string
func GetPricingPlanPlanTypeEnumStringValues() []string
func GetSortOrderEnumStringValues() []string
func GetSourceTypeEnumStringValues() []string
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
type ActionTypeEnum
    func GetActionTypeEnumValues() []ActionTypeEnum
    func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
type ActivateSubscriptionDetails
    func (m ActivateSubscriptionDetails) String() string
    func (m ActivateSubscriptionDetails) ValidateEnumValue() (bool, error)
type ActivateSubscriptionRequest
    func (request ActivateSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ActivateSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ActivateSubscriptionRequest) RetryPolicy() *common.RetryPolicy
    func (request ActivateSubscriptionRequest) String() string
    func (request ActivateSubscriptionRequest) ValidateEnumValue() (bool, error)
type ActivateSubscriptionResponse
    func (response ActivateSubscriptionResponse) HTTPResponse() *http.Response
    func (response ActivateSubscriptionResponse) String() string
type ActivateSubscriptionResult
    func (m ActivateSubscriptionResult) String() string
    func (m ActivateSubscriptionResult) ValidateEnumValue() (bool, error)
type BillingDetails
    func (m BillingDetails) String() string
    func (m BillingDetails) ValidateEnumValue() (bool, error)
type BillingDetailsBillingModelEnum
    func GetBillingDetailsBillingModelEnumValues() []BillingDetailsBillingModelEnum
    func GetMappingBillingDetailsBillingModelEnum(val string) (BillingDetailsBillingModelEnum, bool)
type BillingFrequencyEnum
    func GetBillingFrequencyEnumValues() []BillingFrequencyEnum
    func GetMappingBillingFrequencyEnum(val string) (BillingFrequencyEnum, bool)
type CancelSubscriptionDetails
    func (m CancelSubscriptionDetails) String() string
    func (m CancelSubscriptionDetails) ValidateEnumValue() (bool, error)
type CancelSubscriptionRequest
    func (request CancelSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request CancelSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request CancelSubscriptionRequest) RetryPolicy() *common.RetryPolicy
    func (request CancelSubscriptionRequest) String() string
    func (request CancelSubscriptionRequest) ValidateEnumValue() (bool, error)
type CancelSubscriptionResponse
    func (response CancelSubscriptionResponse) HTTPResponse() *http.Response
    func (response CancelSubscriptionResponse) String() string
type CancelWorkRequestRequest
    func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request CancelWorkRequestRequest) String() string
    func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)
type CancelWorkRequestResponse
    func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
    func (response CancelWorkRequestResponse) String() string
type ChangeSubscriptionCompartmentDetails
    func (m ChangeSubscriptionCompartmentDetails) String() string
    func (m ChangeSubscriptionCompartmentDetails) ValidateEnumValue() (bool, error)
type ChangeSubscriptionCompartmentRequest
    func (request ChangeSubscriptionCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ChangeSubscriptionCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ChangeSubscriptionCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeSubscriptionCompartmentRequest) String() string
    func (request ChangeSubscriptionCompartmentRequest) ValidateEnumValue() (bool, error)
type ChangeSubscriptionCompartmentResponse
    func (response ChangeSubscriptionCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeSubscriptionCompartmentResponse) String() string
type CreateSubscriptionDetails
    func (m CreateSubscriptionDetails) String() string
    func (m CreateSubscriptionDetails) ValidateEnumValue() (bool, error)
type CreateSubscriptionRequest
    func (request CreateSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request CreateSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request CreateSubscriptionRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateSubscriptionRequest) String() string
    func (request CreateSubscriptionRequest) ValidateEnumValue() (bool, error)
type CreateSubscriptionResponse
    func (response CreateSubscriptionResponse) HTTPResponse() *http.Response
    func (response CreateSubscriptionResponse) String() string
type CreateSubscriptionUsageRecordDetails
    func (m CreateSubscriptionUsageRecordDetails) String() string
    func (m CreateSubscriptionUsageRecordDetails) ValidateEnumValue() (bool, error)
type CreateSubscriptionUsageRecordDetailsBillingTypeEnum
    func GetCreateSubscriptionUsageRecordDetailsBillingTypeEnumValues() []CreateSubscriptionUsageRecordDetailsBillingTypeEnum
    func GetMappingCreateSubscriptionUsageRecordDetailsBillingTypeEnum(val string) (CreateSubscriptionUsageRecordDetailsBillingTypeEnum, bool)
type DeleteSubscriptionRequest
    func (request DeleteSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request DeleteSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request DeleteSubscriptionRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteSubscriptionRequest) String() string
    func (request DeleteSubscriptionRequest) ValidateEnumValue() (bool, error)
type DeleteSubscriptionResponse
    func (response DeleteSubscriptionResponse) HTTPResponse() *http.Response
    func (response DeleteSubscriptionResponse) String() string
type ExtendedMetadata
    func (m ExtendedMetadata) String() string
    func (m ExtendedMetadata) ValidateEnumValue() (bool, error)
type GetSubscriptionRequest
    func (request GetSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetSubscriptionRequest) RetryPolicy() *common.RetryPolicy
    func (request GetSubscriptionRequest) String() string
    func (request GetSubscriptionRequest) ValidateEnumValue() (bool, error)
type GetSubscriptionResponse
    func (response GetSubscriptionResponse) HTTPResponse() *http.Response
    func (response GetSubscriptionResponse) String() string
type GetSubscriptionTokenRequest
    func (request GetSubscriptionTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetSubscriptionTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetSubscriptionTokenRequest) RetryPolicy() *common.RetryPolicy
    func (request GetSubscriptionTokenRequest) String() string
    func (request GetSubscriptionTokenRequest) ValidateEnumValue() (bool, error)
type GetSubscriptionTokenResponse
    func (response GetSubscriptionTokenResponse) HTTPResponse() *http.Response
    func (response GetSubscriptionTokenResponse) String() string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
    func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type LifecycleDetailsEnumEnum
    func GetLifecycleDetailsEnumEnumValues() []LifecycleDetailsEnumEnum
    func GetMappingLifecycleDetailsEnumEnum(val string) (LifecycleDetailsEnumEnum, bool)
type LifecycleStateEnumEnum
    func GetLifecycleStateEnumEnumValues() []LifecycleStateEnumEnum
    func GetMappingLifecycleStateEnumEnum(val string) (LifecycleStateEnumEnum, bool)
type ListPartnersRequest
    func (request ListPartnersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListPartnersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListPartnersRequest) RetryPolicy() *common.RetryPolicy
    func (request ListPartnersRequest) String() string
    func (request ListPartnersRequest) ValidateEnumValue() (bool, error)
type ListPartnersResponse
    func (response ListPartnersResponse) HTTPResponse() *http.Response
    func (response ListPartnersResponse) String() string
type ListPartnersSortByEnum
    func GetListPartnersSortByEnumValues() []ListPartnersSortByEnum
    func GetMappingListPartnersSortByEnum(val string) (ListPartnersSortByEnum, bool)
type ListPartnersSortOrderEnum
    func GetListPartnersSortOrderEnumValues() []ListPartnersSortOrderEnum
    func GetMappingListPartnersSortOrderEnum(val string) (ListPartnersSortOrderEnum, bool)
type ListSubscriptionsLifecycleDetailsEnum
    func GetListSubscriptionsLifecycleDetailsEnumValues() []ListSubscriptionsLifecycleDetailsEnum
    func GetMappingListSubscriptionsLifecycleDetailsEnum(val string) (ListSubscriptionsLifecycleDetailsEnum, bool)
type ListSubscriptionsRequest
    func (request ListSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListSubscriptionsRequest) String() string
    func (request ListSubscriptionsRequest) ValidateEnumValue() (bool, error)
type ListSubscriptionsResponse
    func (response ListSubscriptionsResponse) HTTPResponse() *http.Response
    func (response ListSubscriptionsResponse) String() string
type ListSubscriptionsSortByEnum
    func GetListSubscriptionsSortByEnumValues() []ListSubscriptionsSortByEnum
    func GetMappingListSubscriptionsSortByEnum(val string) (ListSubscriptionsSortByEnum, bool)
type ListSubscriptionsSortOrderEnum
    func GetListSubscriptionsSortOrderEnumValues() []ListSubscriptionsSortOrderEnum
    func GetMappingListSubscriptionsSortOrderEnum(val string) (ListSubscriptionsSortOrderEnum, bool)
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
    func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestErrorsSortByEnum
    func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
    func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
type ListWorkRequestErrorsSortOrderEnum
    func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
    func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
    func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestLogsSortByEnum
    func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
    func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
type ListWorkRequestLogsSortOrderEnum
    func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
    func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
    func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type ListWorkRequestsSortByEnum
    func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
    func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
type ListWorkRequestsSortOrderEnum
    func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
    func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
type ListWorkRequestsStatusEnum
    func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
    func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
type ListingSubscriptionSummary
    func (m ListingSubscriptionSummary) String() string
    func (m ListingSubscriptionSummary) ValidateEnumValue() (bool, error)
type ListingSubscriptionsCollection
    func (m ListingSubscriptionsCollection) String() string
    func (m ListingSubscriptionsCollection) ValidateEnumValue() (bool, error)
type ListingSubscriptionsRequest
    func (request ListingSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListingSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListingSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListingSubscriptionsRequest) String() string
    func (request ListingSubscriptionsRequest) ValidateEnumValue() (bool, error)
type ListingSubscriptionsResponse
    func (response ListingSubscriptionsResponse) HTTPResponse() *http.Response
    func (response ListingSubscriptionsResponse) String() string
type ListingSubscriptionsSortByEnum
    func GetListingSubscriptionsSortByEnumValues() []ListingSubscriptionsSortByEnum
    func GetMappingListingSubscriptionsSortByEnum(val string) (ListingSubscriptionsSortByEnum, bool)
type ListingSubscriptionsSortOrderEnum
    func GetListingSubscriptionsSortOrderEnumValues() []ListingSubscriptionsSortOrderEnum
    func GetMappingListingSubscriptionsSortOrderEnum(val string) (ListingSubscriptionsSortOrderEnum, bool)
type Meter
    func (m Meter) String() string
    func (m Meter) ValidateEnumValue() (bool, error)
type MetricTypeEnum
    func GetMappingMetricTypeEnum(val string) (MetricTypeEnum, bool)
    func GetMetricTypeEnumValues() []MetricTypeEnum
type OperationStatusEnum
    func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
    func GetOperationStatusEnumValues() []OperationStatusEnum
type OperationTypeEnum
    func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
    func GetOperationTypeEnumValues() []OperationTypeEnum
type Partner
    func (m Partner) String() string
    func (m Partner) ValidateEnumValue() (bool, error)
type PartnerCollection
    func (m PartnerCollection) String() string
    func (m PartnerCollection) ValidateEnumValue() (bool, error)
type PartnerIntegerationClient
    func NewPartnerIntegerationClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client PartnerIntegerationClient, err error)
    func NewPartnerIntegerationClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client PartnerIntegerationClient, err error)
    func (client PartnerIntegerationClient) ActivateSubscription(ctx context.Context, request ActivateSubscriptionRequest) (response ActivateSubscriptionResponse, err error)
    func (client *PartnerIntegerationClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client PartnerIntegerationClient) ListPartners(ctx context.Context, request ListPartnersRequest) (response ListPartnersResponse, err error)
    func (client PartnerIntegerationClient) ListingSubscriptions(ctx context.Context, request ListingSubscriptionsRequest) (response ListingSubscriptionsResponse, err error)
    func (client PartnerIntegerationClient) ResolveSubscription(ctx context.Context, request ResolveSubscriptionRequest) (response ResolveSubscriptionResponse, err error)
    func (client *PartnerIntegerationClient) SetRegion(region string)
    func (client PartnerIntegerationClient) SubmitSubscriptionUsageBatch(ctx context.Context, request SubmitSubscriptionUsageBatchRequest) (response SubmitSubscriptionUsageBatchResponse, err error)
    func (client PartnerIntegerationClient) SubmitSubscriptionUsageRecords(ctx context.Context, request SubmitSubscriptionUsageRecordsRequest) (response SubmitSubscriptionUsageRecordsResponse, err error)
type PartnerLifecycleStateEnum
    func GetMappingPartnerLifecycleStateEnum(val string) (PartnerLifecycleStateEnum, bool)
    func GetPartnerLifecycleStateEnumValues() []PartnerLifecycleStateEnum
type PartnerSubscription
    func (m PartnerSubscription) String() string
    func (m PartnerSubscription) ValidateEnumValue() (bool, error)
type PartnerSummary
    func (m PartnerSummary) String() string
    func (m PartnerSummary) ValidateEnumValue() (bool, error)
type PricingPlan
    func (m PricingPlan) String() string
    func (m PricingPlan) ValidateEnumValue() (bool, error)
type PricingPlanPlanDurationEnum
    func GetMappingPricingPlanPlanDurationEnum(val string) (PricingPlanPlanDurationEnum, bool)
    func GetPricingPlanPlanDurationEnumValues() []PricingPlanPlanDurationEnum
type PricingPlanPlanTypeEnum
    func GetMappingPricingPlanPlanTypeEnum(val string) (PricingPlanPlanTypeEnum, bool)
    func GetPricingPlanPlanTypeEnumValues() []PricingPlanPlanTypeEnum
type PricingRate
    func (m PricingRate) String() string
    func (m PricingRate) ValidateEnumValue() (bool, error)
type ResolveSubscriptionDetails
    func (m ResolveSubscriptionDetails) String() string
    func (m ResolveSubscriptionDetails) ValidateEnumValue() (bool, error)
type ResolveSubscriptionRequest
    func (request ResolveSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ResolveSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ResolveSubscriptionRequest) RetryPolicy() *common.RetryPolicy
    func (request ResolveSubscriptionRequest) String() string
    func (request ResolveSubscriptionRequest) ValidateEnumValue() (bool, error)
type ResolveSubscriptionResponse
    func (response ResolveSubscriptionResponse) HTTPResponse() *http.Response
    func (response ResolveSubscriptionResponse) String() string
type SortOrderEnum
    func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
    func GetSortOrderEnumValues() []SortOrderEnum
type SourceTypeEnum
    func GetMappingSourceTypeEnum(val string) (SourceTypeEnum, bool)
    func GetSourceTypeEnumValues() []SourceTypeEnum
type SubmitSubscriptionUsageBatchRequest
    func (request SubmitSubscriptionUsageBatchRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request SubmitSubscriptionUsageBatchRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request SubmitSubscriptionUsageBatchRequest) RetryPolicy() *common.RetryPolicy
    func (request SubmitSubscriptionUsageBatchRequest) String() string
    func (request SubmitSubscriptionUsageBatchRequest) ValidateEnumValue() (bool, error)
type SubmitSubscriptionUsageBatchResponse
    func (response SubmitSubscriptionUsageBatchResponse) HTTPResponse() *http.Response
    func (response SubmitSubscriptionUsageBatchResponse) String() string
type SubmitSubscriptionUsageRecordsDetails
    func (m SubmitSubscriptionUsageRecordsDetails) String() string
    func (m SubmitSubscriptionUsageRecordsDetails) ValidateEnumValue() (bool, error)
type SubmitSubscriptionUsageRecordsRequest
    func (request SubmitSubscriptionUsageRecordsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request SubmitSubscriptionUsageRecordsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request SubmitSubscriptionUsageRecordsRequest) RetryPolicy() *common.RetryPolicy
    func (request SubmitSubscriptionUsageRecordsRequest) String() string
    func (request SubmitSubscriptionUsageRecordsRequest) ValidateEnumValue() (bool, error)
type SubmitSubscriptionUsageRecordsResponse
    func (response SubmitSubscriptionUsageRecordsResponse) HTTPResponse() *http.Response
    func (response SubmitSubscriptionUsageRecordsResponse) String() string
type Subscription
    func (m Subscription) String() string
    func (m Subscription) ValidateEnumValue() (bool, error)
type SubscriptionClient
    func NewSubscriptionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SubscriptionClient, err error)
    func NewSubscriptionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SubscriptionClient, err error)
    func (client SubscriptionClient) CancelSubscription(ctx context.Context, request CancelSubscriptionRequest) (response CancelSubscriptionResponse, err error)
    func (client SubscriptionClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
    func (client SubscriptionClient) ChangeSubscriptionCompartment(ctx context.Context, request ChangeSubscriptionCompartmentRequest) (response ChangeSubscriptionCompartmentResponse, err error)
    func (client *SubscriptionClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client SubscriptionClient) CreateSubscription(ctx context.Context, request CreateSubscriptionRequest) (response CreateSubscriptionResponse, err error)
    func (client SubscriptionClient) DeleteSubscription(ctx context.Context, request DeleteSubscriptionRequest) (response DeleteSubscriptionResponse, err error)
    func (client SubscriptionClient) GetSubscription(ctx context.Context, request GetSubscriptionRequest) (response GetSubscriptionResponse, err error)
    func (client SubscriptionClient) GetSubscriptionToken(ctx context.Context, request GetSubscriptionTokenRequest) (response GetSubscriptionTokenResponse, err error)
    func (client SubscriptionClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
    func (client SubscriptionClient) ListSubscriptions(ctx context.Context, request ListSubscriptionsRequest) (response ListSubscriptionsResponse, err error)
    func (client SubscriptionClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
    func (client SubscriptionClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
    func (client SubscriptionClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
    func (client *SubscriptionClient) SetRegion(region string)
    func (client SubscriptionClient) UpdateSubscription(ctx context.Context, request UpdateSubscriptionRequest) (response UpdateSubscriptionResponse, err error)
type SubscriptionCollection
    func (m SubscriptionCollection) String() string
    func (m SubscriptionCollection) ValidateEnumValue() (bool, error)
type SubscriptionDetails
    func (m SubscriptionDetails) String() string
    func (m SubscriptionDetails) ValidateEnumValue() (bool, error)
type SubscriptionSummary
    func (m SubscriptionSummary) String() string
    func (m SubscriptionSummary) ValidateEnumValue() (bool, error)
type SubscriptionToken
    func (m SubscriptionToken) String() string
    func (m SubscriptionToken) ValidateEnumValue() (bool, error)
type UpdateSubscriptionDetails
    func (m UpdateSubscriptionDetails) String() string
    func (m UpdateSubscriptionDetails) ValidateEnumValue() (bool, error)
type UpdateSubscriptionRequest
    func (request UpdateSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request UpdateSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request UpdateSubscriptionRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateSubscriptionRequest) String() string
    func (request UpdateSubscriptionRequest) ValidateEnumValue() (bool, error)
type UpdateSubscriptionResponse
    func (response UpdateSubscriptionResponse) HTTPResponse() *http.Response
    func (response UpdateSubscriptionResponse) String() string
type UsageDimension
    func (m UsageDimension) String() string
    func (m UsageDimension) ValidateEnumValue() (bool, error)
type WorkRequest
    func (m WorkRequest) String() string
    func (m WorkRequest) ValidateEnumValue() (bool, error)
type WorkRequestError
    func (m WorkRequestError) String() string
    func (m WorkRequestError) ValidateEnumValue() (bool, error)
type WorkRequestErrorCollection
    func (m WorkRequestErrorCollection) String() string
    func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
type WorkRequestLogEntry
    func (m WorkRequestLogEntry) String() string
    func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
type WorkRequestLogEntryCollection
    func (m WorkRequestLogEntryCollection) String() string
    func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
type WorkRequestResource
    func (m WorkRequestResource) String() string
    func (m WorkRequestResource) ValidateEnumValue() (bool, error)
type WorkRequestResourceMetadataKeyEnum
    func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
    func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
type WorkRequestSummary
    func (m WorkRequestSummary) String() string
    func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
type WorkRequestSummaryCollection
    func (m WorkRequestSummaryCollection) String() string
    func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)

Package files

action_type.go activate_subscription_details.go activate_subscription_request_response.go activate_subscription_result.go billing_details.go billing_frequency.go cancel_subscription_details.go cancel_subscription_request_response.go cancel_work_request_request_response.go change_subscription_compartment_details.go change_subscription_compartment_request_response.go create_subscription_details.go create_subscription_request_response.go create_subscription_usage_record_details.go delete_subscription_request_response.go extended_metadata.go get_subscription_request_response.go get_subscription_token_request_response.go get_work_request_request_response.go lifecycle_details_enum.go lifecycle_state_enum.go list_partners_request_response.go list_subscriptions_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go listing_subscription_summary.go listing_subscriptions_collection.go listing_subscriptions_request_response.go meter.go metric_type.go operation_status.go operation_type.go partner.go partner_collection.go partner_subscription.go partner_summary.go pricing_plan.go pricing_rate.go resolve_subscription_details.go resolve_subscription_request_response.go self_partnerintegeration_client.go self_subscription_client.go sort_order.go source_type.go submit_subscription_usage_batch_request_response.go submit_subscription_usage_records_details.go submit_subscription_usage_records_request_response.go subscription.go subscription_collection.go subscription_details.go subscription_summary.go subscription_token.go update_subscription_details.go update_subscription_request_response.go usage_dimension.go work_request.go work_request_error.go work_request_error_collection.go work_request_log_entry.go work_request_log_entry_collection.go work_request_resource.go work_request_resource_metadata_key.go work_request_summary.go work_request_summary_collection.go

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetBillingDetailsBillingModelEnumStringValues

func GetBillingDetailsBillingModelEnumStringValues() []string

GetBillingDetailsBillingModelEnumStringValues Enumerates the set of values in String for BillingDetailsBillingModelEnum

func GetBillingFrequencyEnumStringValues

func GetBillingFrequencyEnumStringValues() []string

GetBillingFrequencyEnumStringValues Enumerates the set of values in String for BillingFrequencyEnum

func GetCreateSubscriptionUsageRecordDetailsBillingTypeEnumStringValues

func GetCreateSubscriptionUsageRecordDetailsBillingTypeEnumStringValues() []string

GetCreateSubscriptionUsageRecordDetailsBillingTypeEnumStringValues Enumerates the set of values in String for CreateSubscriptionUsageRecordDetailsBillingTypeEnum

func GetLifecycleDetailsEnumEnumStringValues

func GetLifecycleDetailsEnumEnumStringValues() []string

GetLifecycleDetailsEnumEnumStringValues Enumerates the set of values in String for LifecycleDetailsEnumEnum

func GetLifecycleStateEnumEnumStringValues

func GetLifecycleStateEnumEnumStringValues() []string

GetLifecycleStateEnumEnumStringValues Enumerates the set of values in String for LifecycleStateEnumEnum

func GetListPartnersSortByEnumStringValues

func GetListPartnersSortByEnumStringValues() []string

GetListPartnersSortByEnumStringValues Enumerates the set of values in String for ListPartnersSortByEnum

func GetListPartnersSortOrderEnumStringValues

func GetListPartnersSortOrderEnumStringValues() []string

GetListPartnersSortOrderEnumStringValues Enumerates the set of values in String for ListPartnersSortOrderEnum

func GetListSubscriptionsLifecycleDetailsEnumStringValues

func GetListSubscriptionsLifecycleDetailsEnumStringValues() []string

GetListSubscriptionsLifecycleDetailsEnumStringValues Enumerates the set of values in String for ListSubscriptionsLifecycleDetailsEnum

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

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetListingSubscriptionsSortByEnumStringValues

func GetListingSubscriptionsSortByEnumStringValues() []string

GetListingSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListingSubscriptionsSortByEnum

func GetListingSubscriptionsSortOrderEnumStringValues

func GetListingSubscriptionsSortOrderEnumStringValues() []string

GetListingSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListingSubscriptionsSortOrderEnum

func GetMetricTypeEnumStringValues

func GetMetricTypeEnumStringValues() []string

GetMetricTypeEnumStringValues Enumerates the set of values in String for MetricTypeEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetPartnerLifecycleStateEnumStringValues

func GetPartnerLifecycleStateEnumStringValues() []string

GetPartnerLifecycleStateEnumStringValues Enumerates the set of values in String for PartnerLifecycleStateEnum

func GetPricingPlanPlanDurationEnumStringValues

func GetPricingPlanPlanDurationEnumStringValues() []string

GetPricingPlanPlanDurationEnumStringValues Enumerates the set of values in String for PricingPlanPlanDurationEnum

func GetPricingPlanPlanTypeEnumStringValues

func GetPricingPlanPlanTypeEnumStringValues() []string

GetPricingPlanPlanTypeEnumStringValues Enumerates the set of values in String for PricingPlanPlanTypeEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetSourceTypeEnumStringValues

func GetSourceTypeEnumStringValues() []string

GetSourceTypeEnumStringValues Enumerates the set of values in String for SourceTypeEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

type ActionTypeEnum

ActionTypeEnum Enum with underlying type: string

type ActionTypeEnum string

Set of constants representing the allowable values for ActionTypeEnum

const (
    ActionTypeCreated    ActionTypeEnum = "CREATED"
    ActionTypeUpdated    ActionTypeEnum = "UPDATED"
    ActionTypeDeleted    ActionTypeEnum = "DELETED"
    ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
    ActionTypeRelated    ActionTypeEnum = "RELATED"
    ActionTypeFailed     ActionTypeEnum = "FAILED"
)

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type ActivateSubscriptionDetails

ActivateSubscriptionDetails Request model for activating a subscription. Contains necessary details to perform the activation.

type ActivateSubscriptionDetails struct {

    // The unique identifier of the marketplace product listing.
    ProductId *string `mandatory:"true" json:"productId"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (ActivateSubscriptionDetails) String

func (m ActivateSubscriptionDetails) String() string

func (ActivateSubscriptionDetails) ValidateEnumValue

func (m ActivateSubscriptionDetails) 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 ActivateSubscriptionRequest

ActivateSubscriptionRequest wrapper for the ActivateSubscription operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ActivateSubscription.go.html to see an example of how to use ActivateSubscriptionRequest.

type ActivateSubscriptionRequest struct {

    // The unique identifier for the subscription.
    SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

    // The details for activating the subscription.
    ActivateSubscriptionDetails `contributesTo:"body"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of running 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 removed from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
    // `if-match` parameter to the value of the etag from a previous GET or POST response for
    // that resource. The resource will be updated or deleted only if the etag you provide
    // matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

func (ActivateSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ActivateSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ActivateSubscriptionRequest) RetryPolicy

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

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

func (ActivateSubscriptionRequest) String

func (request ActivateSubscriptionRequest) String() string

func (ActivateSubscriptionRequest) ValidateEnumValue

func (request ActivateSubscriptionRequest) 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 ActivateSubscriptionResponse

ActivateSubscriptionResponse wrapper for the ActivateSubscription operation

type ActivateSubscriptionResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

func (ActivateSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ActivateSubscriptionResponse) String

func (response ActivateSubscriptionResponse) String() string

type ActivateSubscriptionResult

ActivateSubscriptionResult Response model for the activation of a subscription. Includes the details of the activated subscription.

type ActivateSubscriptionResult struct {

    // The unique identifier of the activated subscription.
    SubscriptionId *string `mandatory:"true" json:"subscriptionId"`

    // The subscription name. Must be unique within the compartment. This value can be updated.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // The start date of the subscription.
    TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`

    // The end date of the subscription.
    TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`

    // The current state of the Subscription.
    LifecycleState LifecycleStateEnumEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // A message that describes the current state of the Subscription in more detail. For example,
    // can be used to provide actionable information for a resource in the Failed state.
    LifecycleDetails LifecycleDetailsEnumEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
}

func (ActivateSubscriptionResult) String

func (m ActivateSubscriptionResult) String() string

func (ActivateSubscriptionResult) ValidateEnumValue

func (m ActivateSubscriptionResult) 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 BillingDetails

BillingDetails Billing detail entry associated with a subscription.

type BillingDetails struct {

    // Unique key used to map this SKU to the pricing plan.
    PricingPlanKey *string `mandatory:"true" json:"pricingPlanKey"`

    // The billing model this billing detail applies to.
    BillingModel BillingDetailsBillingModelEnum `mandatory:"true" json:"billingModel"`

    // Sku for service.
    Sku *string `mandatory:"true" json:"sku"`

    // The part's metric.
    MetricType MetricTypeEnum `mandatory:"true" json:"metricType"`

    // Tha rate of this sku meter.
    RateAllocation *float32 `mandatory:"true" json:"rateAllocation"`

    // The meters associated with sku.
    Meters []Meter `mandatory:"true" json:"meters"`

    // Whether this sku is assign to gov product.
    HasGovSku *bool `mandatory:"false" json:"hasGovSku"`
}

func (BillingDetails) String

func (m BillingDetails) String() string

func (BillingDetails) ValidateEnumValue

func (m BillingDetails) 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 BillingDetailsBillingModelEnum

BillingDetailsBillingModelEnum Enum with underlying type: string

type BillingDetailsBillingModelEnum string

Set of constants representing the allowable values for BillingDetailsBillingModelEnum

const (
    BillingDetailsBillingModelFlatRate   BillingDetailsBillingModelEnum = "FLAT_RATE"
    BillingDetailsBillingModelUsageBased BillingDetailsBillingModelEnum = "USAGE_BASED"
)

func GetBillingDetailsBillingModelEnumValues

func GetBillingDetailsBillingModelEnumValues() []BillingDetailsBillingModelEnum

GetBillingDetailsBillingModelEnumValues Enumerates the set of values for BillingDetailsBillingModelEnum

func GetMappingBillingDetailsBillingModelEnum

func GetMappingBillingDetailsBillingModelEnum(val string) (BillingDetailsBillingModelEnum, bool)

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

type BillingFrequencyEnum

BillingFrequencyEnum Enum with underlying type: string

type BillingFrequencyEnum string

Set of constants representing the allowable values for BillingFrequencyEnum

const (
    BillingFrequencyMonthly    BillingFrequencyEnum = "MONTHLY"
    BillingFrequencyQuarterly  BillingFrequencyEnum = "QUARTERLY"
    BillingFrequencySemiAnnual BillingFrequencyEnum = "SEMI_ANNUAL"
    BillingFrequencyAnnual     BillingFrequencyEnum = "ANNUAL"
    BillingFrequencyBiennial   BillingFrequencyEnum = "BIENNIAL"
    BillingFrequencyTriennial  BillingFrequencyEnum = "TRIENNIAL"
    BillingFrequencyYearly     BillingFrequencyEnum = "YEARLY"
)

func GetBillingFrequencyEnumValues

func GetBillingFrequencyEnumValues() []BillingFrequencyEnum

GetBillingFrequencyEnumValues Enumerates the set of values for BillingFrequencyEnum

func GetMappingBillingFrequencyEnum

func GetMappingBillingFrequencyEnum(val string) (BillingFrequencyEnum, bool)

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

type CancelSubscriptionDetails

CancelSubscriptionDetails The data to cancel a Subscription.

type CancelSubscriptionDetails struct {

    // Optional reason provided by the customer for the cancellation.
    Reason *string `mandatory:"false" json:"reason"`
}

func (CancelSubscriptionDetails) String

func (m CancelSubscriptionDetails) String() string

func (CancelSubscriptionDetails) ValidateEnumValue

func (m CancelSubscriptionDetails) 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 CancelSubscriptionRequest

CancelSubscriptionRequest wrapper for the CancelSubscription operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/CancelSubscription.go.html to see an example of how to use CancelSubscriptionRequest.

type CancelSubscriptionRequest struct {

    // The unique identifier for the subscription.
    SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

    // Details for the cancellation request.
    CancelSubscriptionDetails `contributesTo:"body"`

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

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of running 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 removed from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

func (CancelSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CancelSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CancelSubscriptionRequest) RetryPolicy

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

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

func (CancelSubscriptionRequest) String

func (request CancelSubscriptionRequest) String() string

func (CancelSubscriptionRequest) ValidateEnumValue

func (request CancelSubscriptionRequest) 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 CancelSubscriptionResponse

CancelSubscriptionResponse wrapper for the CancelSubscription operation

type CancelSubscriptionResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // 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 (CancelSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelSubscriptionResponse) String

func (response CancelSubscriptionResponse) String() string

type CancelWorkRequestRequest

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.

type CancelWorkRequestRequest struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

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

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (CancelWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy

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

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

func (CancelWorkRequestRequest) String

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue

func (request CancelWorkRequestRequest) 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 CancelWorkRequestResponse

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

type CancelWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (CancelWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String

func (response CancelWorkRequestResponse) String() string

type ChangeSubscriptionCompartmentDetails

ChangeSubscriptionCompartmentDetails The configuration details for the move operation.

type ChangeSubscriptionCompartmentDetails struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the Subscription to.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangeSubscriptionCompartmentDetails) String

func (m ChangeSubscriptionCompartmentDetails) String() string

func (ChangeSubscriptionCompartmentDetails) ValidateEnumValue

func (m ChangeSubscriptionCompartmentDetails) 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 ChangeSubscriptionCompartmentRequest

ChangeSubscriptionCompartmentRequest wrapper for the ChangeSubscriptionCompartment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ChangeSubscriptionCompartment.go.html to see an example of how to use ChangeSubscriptionCompartmentRequest.

type ChangeSubscriptionCompartmentRequest struct {

    // The unique identifier for the subscription.
    SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

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

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

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of running 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 removed from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

func (ChangeSubscriptionCompartmentRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeSubscriptionCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeSubscriptionCompartmentRequest) RetryPolicy

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

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

func (ChangeSubscriptionCompartmentRequest) String

func (request ChangeSubscriptionCompartmentRequest) String() string

func (ChangeSubscriptionCompartmentRequest) ValidateEnumValue

func (request ChangeSubscriptionCompartmentRequest) 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 ChangeSubscriptionCompartmentResponse

ChangeSubscriptionCompartmentResponse wrapper for the ChangeSubscriptionCompartment operation

type ChangeSubscriptionCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
    // Use GetWorkRequest with this ID to track the status of the request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // 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 (ChangeSubscriptionCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeSubscriptionCompartmentResponse) String

func (response ChangeSubscriptionCompartmentResponse) String() string

type CreateSubscriptionDetails

CreateSubscriptionDetails The data to create a Subscription.

type CreateSubscriptionDetails struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the subscription in.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenant to create the subscription in.
    TenantId *string `mandatory:"true" json:"tenantId"`

    SubscriptionDetails *SubscriptionDetails `mandatory:"true" json:"subscriptionDetails"`

    // The OCID for the seller in SELF Service.
    SellerId *string `mandatory:"true" json:"sellerId"`

    // The unique identifier of the marketplace listing in Oracle Cloud Infrastructure.
    ProductId *string `mandatory:"true" json:"productId"`

    // The subscription name. Must be unique within the compartment. This value can be updated.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // The type of seller in SELF Service.
    SourceType SourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`

    // Additional details that are specific for this subscription such as activation details.
    AdditionalDetails []ExtendedMetadata `mandatory:"false" json:"additionalDetails"`

    // The realm from where customer is buying the subscription.
    Realm *string `mandatory:"false" json:"realm"`

    // The region from where customer is buying the subscription.
    Region *string `mandatory:"false" json:"region"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateSubscriptionDetails) String

func (m CreateSubscriptionDetails) String() string

func (CreateSubscriptionDetails) ValidateEnumValue

func (m CreateSubscriptionDetails) 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 CreateSubscriptionRequest

CreateSubscriptionRequest wrapper for the CreateSubscription operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/CreateSubscription.go.html to see an example of how to use CreateSubscriptionRequest.

type CreateSubscriptionRequest struct {

    // Details for the new Subscription.
    CreateSubscriptionDetails `contributesTo:"body"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of running 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 removed from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (CreateSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateSubscriptionRequest) RetryPolicy

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

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

func (CreateSubscriptionRequest) String

func (request CreateSubscriptionRequest) String() string

func (CreateSubscriptionRequest) ValidateEnumValue

func (request CreateSubscriptionRequest) 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 CreateSubscriptionResponse

CreateSubscriptionResponse wrapper for the CreateSubscription operation

type CreateSubscriptionResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // URL for the created subscription. The subscription OCID is generated after this request is sent.
    Location *string `presentIn:"header" name:"location"`

    // Same as location.
    ContentLocation *string `presentIn:"header" name:"content-location"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
    // Use GetWorkRequest with this ID to track the status of the request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // 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 (CreateSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateSubscriptionResponse) String

func (response CreateSubscriptionResponse) String() string

type CreateSubscriptionUsageRecordDetails

CreateSubscriptionUsageRecordDetails A single usage record to submit for a marketplace offer. The usage window must have `timeUsageStarted` before `timeUsageEnded`.

type CreateSubscriptionUsageRecordDetails struct {

    // Partner-provided unique identifier for this usage record. This identifier must be unique per partner.
    Id *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the marketplace offer being billed. A submit request can contain records for multiple marketplace offers.
    MarketplaceOfferId *string `mandatory:"true" json:"marketplaceOfferId"`

    // The pricing dimension against which usage is being reported.
    UsageDimensionName *string `mandatory:"true" json:"usageDimensionName"`

    // The non-negative usage cost computed by the partner for the submitted usage quantity.
    Amount *float64 `mandatory:"true" json:"amount"`

    // The ISO-4217 currency submitted for the computed usage cost.
    CurrencyCode *string `mandatory:"true" json:"currencyCode"`

    // The inclusive start timestamp for the usage window. This value must be before `timeUsageEnded`.
    TimeUsageStarted *common.SDKTime `mandatory:"true" json:"timeUsageStarted"`

    // The exclusive end timestamp for the usage window. This value must be after `timeUsageStarted`.
    TimeUsageEnded *common.SDKTime `mandatory:"true" json:"timeUsageEnded"`

    // The billing type this usage record applies to.
    BillingType CreateSubscriptionUsageRecordDetailsBillingTypeEnum `mandatory:"false" json:"billingType,omitempty"`

    // An optional non-negative usage quantity being reported.
    ConsumedQuantity *float64 `mandatory:"false" json:"consumedQuantity"`

    // The billing period associated with this usage record in `YYYY-MM` format.
    BillingPeriod *string `mandatory:"false" json:"billingPeriod"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer tenancy associated with this usage record.
    CustomerTenancyId *string `mandatory:"false" json:"customerTenancyId"`

    // The partner billing identifier associated with this usage record.
    BillingIdentifier *string `mandatory:"false" json:"billingIdentifier"`

    // The unit of measure associated with the reported usage quantity.
    UnitOfMeasure *string `mandatory:"false" json:"unitOfMeasure"`

    // The unit price associated with this usage record.
    UnitPrice *float64 `mandatory:"false" json:"unitPrice"`

    // The product SKU associated with this usage record.
    ProductSku *string `mandatory:"false" json:"productSku"`

    // The contract duration associated with this usage record.
    ContractDuration BillingFrequencyEnum `mandatory:"false" json:"contractDuration,omitempty"`

    // Additional key/value metadata associated with this usage record for extensibility.
    AdditionalMetadata []ExtendedMetadata `mandatory:"false" json:"additionalMetadata"`

    // Partner-provided usage record identifier for traceability.
    UsageRecordId *string `mandatory:"false" json:"usageRecordId"`
}

func (CreateSubscriptionUsageRecordDetails) String

func (m CreateSubscriptionUsageRecordDetails) String() string

func (CreateSubscriptionUsageRecordDetails) ValidateEnumValue

func (m CreateSubscriptionUsageRecordDetails) 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 CreateSubscriptionUsageRecordDetailsBillingTypeEnum

CreateSubscriptionUsageRecordDetailsBillingTypeEnum Enum with underlying type: string

type CreateSubscriptionUsageRecordDetailsBillingTypeEnum string

Set of constants representing the allowable values for CreateSubscriptionUsageRecordDetailsBillingTypeEnum

const (
    CreateSubscriptionUsageRecordDetailsBillingTypeFlatRate   CreateSubscriptionUsageRecordDetailsBillingTypeEnum = "FLAT_RATE"
    CreateSubscriptionUsageRecordDetailsBillingTypeUsageBased CreateSubscriptionUsageRecordDetailsBillingTypeEnum = "USAGE_BASED"
)

func GetCreateSubscriptionUsageRecordDetailsBillingTypeEnumValues

func GetCreateSubscriptionUsageRecordDetailsBillingTypeEnumValues() []CreateSubscriptionUsageRecordDetailsBillingTypeEnum

GetCreateSubscriptionUsageRecordDetailsBillingTypeEnumValues Enumerates the set of values for CreateSubscriptionUsageRecordDetailsBillingTypeEnum

func GetMappingCreateSubscriptionUsageRecordDetailsBillingTypeEnum

func GetMappingCreateSubscriptionUsageRecordDetailsBillingTypeEnum(val string) (CreateSubscriptionUsageRecordDetailsBillingTypeEnum, bool)

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

type DeleteSubscriptionRequest

DeleteSubscriptionRequest wrapper for the DeleteSubscription operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/DeleteSubscription.go.html to see an example of how to use DeleteSubscriptionRequest.

type DeleteSubscriptionRequest struct {

    // The unique identifier for the subscription.
    SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

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

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (DeleteSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteSubscriptionRequest) RetryPolicy

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

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

func (DeleteSubscriptionRequest) String

func (request DeleteSubscriptionRequest) String() string

func (DeleteSubscriptionRequest) ValidateEnumValue

func (request DeleteSubscriptionRequest) 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 DeleteSubscriptionResponse

DeleteSubscriptionResponse wrapper for the DeleteSubscription operation

type DeleteSubscriptionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
    // Use GetWorkRequest with this ID to track the status of the request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // 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 (DeleteSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteSubscriptionResponse) String

func (response DeleteSubscriptionResponse) String() string

type ExtendedMetadata

ExtendedMetadata Additional metadata key/value pairs.

type ExtendedMetadata struct {

    // Additional attribute for extendedMetadata.
    Key *string `mandatory:"true" json:"key"`

    // It contains the value of above key.
    Value *string `mandatory:"true" json:"value"`
}

func (ExtendedMetadata) String

func (m ExtendedMetadata) String() string

func (ExtendedMetadata) ValidateEnumValue

func (m ExtendedMetadata) 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 GetSubscriptionRequest

GetSubscriptionRequest wrapper for the GetSubscription operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetSubscription.go.html to see an example of how to use GetSubscriptionRequest.

type GetSubscriptionRequest struct {

    // The unique identifier for the subscription.
    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.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (GetSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetSubscriptionRequest) RetryPolicy

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

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

func (GetSubscriptionRequest) String

func (request GetSubscriptionRequest) String() string

func (GetSubscriptionRequest) ValidateEnumValue

func (request GetSubscriptionRequest) 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 GetSubscriptionResponse

GetSubscriptionResponse wrapper for the GetSubscription operation

type GetSubscriptionResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // 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 (GetSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetSubscriptionResponse) String

func (response GetSubscriptionResponse) String() string

type GetSubscriptionTokenRequest

GetSubscriptionTokenRequest wrapper for the GetSubscriptionToken operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetSubscriptionToken.go.html to see an example of how to use GetSubscriptionTokenRequest.

type GetSubscriptionTokenRequest struct {

    // The unique identifier for the subscription.
    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.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (GetSubscriptionTokenRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetSubscriptionTokenRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetSubscriptionTokenRequest) RetryPolicy

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

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

func (GetSubscriptionTokenRequest) String

func (request GetSubscriptionTokenRequest) String() string

func (GetSubscriptionTokenRequest) ValidateEnumValue

func (request GetSubscriptionTokenRequest) 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 GetSubscriptionTokenResponse

GetSubscriptionTokenResponse wrapper for the GetSubscriptionToken operation

type GetSubscriptionTokenResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The SubscriptionToken instance
    SubscriptionToken `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 list pagination. When this header appears in the response, additional pages of results remain. For
    // important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (GetSubscriptionTokenResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetSubscriptionTokenResponse) String

func (response GetSubscriptionTokenResponse) String() string

type GetWorkRequestRequest

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

type GetWorkRequestRequest struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (GetWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

func (request GetWorkRequestRequest) 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 GetWorkRequestResponse

GetWorkRequestResponse wrapper for the GetWorkRequest operation

type GetWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

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

    // A decimal number representing the number of seconds the client should wait before polling this endpoint again.
    RetryAfter *int `presentIn:"header" name:"retry-after"`
}

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type LifecycleDetailsEnumEnum

LifecycleDetailsEnumEnum Enum with underlying type: string

type LifecycleDetailsEnumEnum string

Set of constants representing the allowable values for LifecycleDetailsEnumEnum

const (
    LifecycleDetailsEnumCreated               LifecycleDetailsEnumEnum = "CREATED"
    LifecycleDetailsEnumPendingActivation     LifecycleDetailsEnumEnum = "PENDING_ACTIVATION"
    LifecycleDetailsEnumProvisioningStarted   LifecycleDetailsEnumEnum = "PROVISIONING_STARTED"
    LifecycleDetailsEnumProvisioningCompleted LifecycleDetailsEnumEnum = "PROVISIONING_COMPLETED"
    LifecycleDetailsEnumProvisioningFailed    LifecycleDetailsEnumEnum = "PROVISIONING_FAILED"
    LifecycleDetailsEnumActive                LifecycleDetailsEnumEnum = "ACTIVE"
    LifecycleDetailsEnumExpired               LifecycleDetailsEnumEnum = "EXPIRED"
    LifecycleDetailsEnumTerminated            LifecycleDetailsEnumEnum = "TERMINATED"
    LifecycleDetailsEnumFailed                LifecycleDetailsEnumEnum = "FAILED"
    LifecycleDetailsEnumDeleting              LifecycleDetailsEnumEnum = "DELETING"
    LifecycleDetailsEnumUpdating              LifecycleDetailsEnumEnum = "UPDATING"
    LifecycleDetailsEnumDeleted               LifecycleDetailsEnumEnum = "DELETED"
    LifecycleDetailsEnumPendingCancellation   LifecycleDetailsEnumEnum = "PENDING_CANCELLATION"
    LifecycleDetailsEnumSuspended             LifecycleDetailsEnumEnum = "SUSPENDED"
    LifecycleDetailsEnumCanceled              LifecycleDetailsEnumEnum = "CANCELED"
)

func GetLifecycleDetailsEnumEnumValues

func GetLifecycleDetailsEnumEnumValues() []LifecycleDetailsEnumEnum

GetLifecycleDetailsEnumEnumValues Enumerates the set of values for LifecycleDetailsEnumEnum

func GetMappingLifecycleDetailsEnumEnum

func GetMappingLifecycleDetailsEnumEnum(val string) (LifecycleDetailsEnumEnum, bool)

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

type LifecycleStateEnumEnum

LifecycleStateEnumEnum Enum with underlying type: string

type LifecycleStateEnumEnum string

Set of constants representing the allowable values for LifecycleStateEnumEnum

const (
    LifecycleStateEnumActive   LifecycleStateEnumEnum = "ACTIVE"
    LifecycleStateEnumInactive LifecycleStateEnumEnum = "INACTIVE"
    LifecycleStateEnumDeleted  LifecycleStateEnumEnum = "DELETED"
    LifecycleStateEnumFailed   LifecycleStateEnumEnum = "FAILED"
)

func GetLifecycleStateEnumEnumValues

func GetLifecycleStateEnumEnumValues() []LifecycleStateEnumEnum

GetLifecycleStateEnumEnumValues Enumerates the set of values for LifecycleStateEnumEnum

func GetMappingLifecycleStateEnumEnum

func GetMappingLifecycleStateEnumEnum(val string) (LifecycleStateEnumEnum, bool)

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

type ListPartnersRequest

ListPartnersRequest wrapper for the ListPartners operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListPartners.go.html to see an example of how to use ListPartnersRequest.

type ListPartnersRequest struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // A filter to return only resources that match the given name.
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // The field to sort by. Only one sort order may be provided.
    SortBy ListPartnersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`).
    SortOrder ListPartnersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the opc-next-page response header from the previous
    // "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (ListPartnersRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListPartnersRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListPartnersRequest) RetryPolicy

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

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

func (ListPartnersRequest) String

func (request ListPartnersRequest) String() string

func (ListPartnersRequest) ValidateEnumValue

func (request ListPartnersRequest) 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 ListPartnersResponse

ListPartnersResponse wrapper for the ListPartners operation

type ListPartnersResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of PartnerCollection instances
    PartnerCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
    // important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListPartnersResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListPartnersResponse) String

func (response ListPartnersResponse) String() string

type ListPartnersSortByEnum

ListPartnersSortByEnum Enum with underlying type: string

type ListPartnersSortByEnum string

Set of constants representing the allowable values for ListPartnersSortByEnum

const (
    ListPartnersSortByTimecreated ListPartnersSortByEnum = "timeCreated"
    ListPartnersSortByDisplayname ListPartnersSortByEnum = "displayName"
    ListPartnersSortByProductid   ListPartnersSortByEnum = "productId"
)

func GetListPartnersSortByEnumValues

func GetListPartnersSortByEnumValues() []ListPartnersSortByEnum

GetListPartnersSortByEnumValues Enumerates the set of values for ListPartnersSortByEnum

func GetMappingListPartnersSortByEnum

func GetMappingListPartnersSortByEnum(val string) (ListPartnersSortByEnum, bool)

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

type ListPartnersSortOrderEnum

ListPartnersSortOrderEnum Enum with underlying type: string

type ListPartnersSortOrderEnum string

Set of constants representing the allowable values for ListPartnersSortOrderEnum

const (
    ListPartnersSortOrderAsc  ListPartnersSortOrderEnum = "ASC"
    ListPartnersSortOrderDesc ListPartnersSortOrderEnum = "DESC"
)

func GetListPartnersSortOrderEnumValues

func GetListPartnersSortOrderEnumValues() []ListPartnersSortOrderEnum

GetListPartnersSortOrderEnumValues Enumerates the set of values for ListPartnersSortOrderEnum

func GetMappingListPartnersSortOrderEnum

func GetMappingListPartnersSortOrderEnum(val string) (ListPartnersSortOrderEnum, bool)

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

type ListSubscriptionsLifecycleDetailsEnum

ListSubscriptionsLifecycleDetailsEnum Enum with underlying type: string

type ListSubscriptionsLifecycleDetailsEnum string

Set of constants representing the allowable values for ListSubscriptionsLifecycleDetailsEnum

const (
    ListSubscriptionsLifecycleDetailsCreated               ListSubscriptionsLifecycleDetailsEnum = "CREATED"
    ListSubscriptionsLifecycleDetailsPendingActivation     ListSubscriptionsLifecycleDetailsEnum = "PENDING_ACTIVATION"
    ListSubscriptionsLifecycleDetailsProvisioningStarted   ListSubscriptionsLifecycleDetailsEnum = "PROVISIONING_STARTED"
    ListSubscriptionsLifecycleDetailsProvisioningCompleted ListSubscriptionsLifecycleDetailsEnum = "PROVISIONING_COMPLETED"
    ListSubscriptionsLifecycleDetailsProvisioningFailed    ListSubscriptionsLifecycleDetailsEnum = "PROVISIONING_FAILED"
    ListSubscriptionsLifecycleDetailsActive                ListSubscriptionsLifecycleDetailsEnum = "ACTIVE"
    ListSubscriptionsLifecycleDetailsExpired               ListSubscriptionsLifecycleDetailsEnum = "EXPIRED"
    ListSubscriptionsLifecycleDetailsTerminated            ListSubscriptionsLifecycleDetailsEnum = "TERMINATED"
    ListSubscriptionsLifecycleDetailsFailed                ListSubscriptionsLifecycleDetailsEnum = "FAILED"
    ListSubscriptionsLifecycleDetailsDeleting              ListSubscriptionsLifecycleDetailsEnum = "DELETING"
    ListSubscriptionsLifecycleDetailsUpdating              ListSubscriptionsLifecycleDetailsEnum = "UPDATING"
    ListSubscriptionsLifecycleDetailsDeleted               ListSubscriptionsLifecycleDetailsEnum = "DELETED"
    ListSubscriptionsLifecycleDetailsPendingCancellation   ListSubscriptionsLifecycleDetailsEnum = "PENDING_CANCELLATION"
    ListSubscriptionsLifecycleDetailsSuspended             ListSubscriptionsLifecycleDetailsEnum = "SUSPENDED"
    ListSubscriptionsLifecycleDetailsCanceled              ListSubscriptionsLifecycleDetailsEnum = "CANCELED"
)

func GetListSubscriptionsLifecycleDetailsEnumValues

func GetListSubscriptionsLifecycleDetailsEnumValues() []ListSubscriptionsLifecycleDetailsEnum

GetListSubscriptionsLifecycleDetailsEnumValues Enumerates the set of values for ListSubscriptionsLifecycleDetailsEnum

func GetMappingListSubscriptionsLifecycleDetailsEnum

func GetMappingListSubscriptionsLifecycleDetailsEnum(val string) (ListSubscriptionsLifecycleDetailsEnum, bool)

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

type ListSubscriptionsRequest

ListSubscriptionsRequest wrapper for the ListSubscriptions operation

See also

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

type ListSubscriptionsRequest struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // A filter to return only resources that match the given lifecycle state. The
    // state value is case-insensitive.
    LifecycleDetails ListSubscriptionsLifecycleDetailsEnum `mandatory:"false" contributesTo:"query" name:"lifecycleDetails" omitEmpty:"true"`

    // A filter to return only resources that match the given name.
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Subscription.
    Id *string `mandatory:"false" contributesTo:"query" name:"id"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the opc-next-page response header from the previous
    // "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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. Only one sort order may be provided.
    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.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (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

ListSubscriptionsResponse wrapper for the ListSubscriptions operation

type ListSubscriptionsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of SubscriptionCollection instances
    SubscriptionCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
    // important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListSubscriptionsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListSubscriptionsResponse) String

func (response ListSubscriptionsResponse) String() string

type ListSubscriptionsSortByEnum

ListSubscriptionsSortByEnum Enum with underlying type: string

type ListSubscriptionsSortByEnum string

Set of constants representing the allowable values for ListSubscriptionsSortByEnum

const (
    ListSubscriptionsSortByTimecreated ListSubscriptionsSortByEnum = "timeCreated"
    ListSubscriptionsSortByDisplayname ListSubscriptionsSortByEnum = "displayName"
    ListSubscriptionsSortByProductid   ListSubscriptionsSortByEnum = "productId"
)

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

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

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 ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

type ListWorkRequestErrorsRequest struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For list pagination. The value of the opc-next-page response header from the previous
    // "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
    SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`).
    SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

func (ListWorkRequestErrorsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

func (request ListWorkRequestErrorsRequest) 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 ListWorkRequestErrorsResponse

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

type ListWorkRequestErrorsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For list pagination. When this header appears in the response, additional pages of results remain. For
    // important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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 (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

type ListWorkRequestErrorsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

const (
    ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

type ListWorkRequestErrorsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

const (
    ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
    ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

type ListWorkRequestLogsRequest struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For list pagination. The value of the opc-next-page response header from the previous
    // "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
    SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`).
    SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

func (ListWorkRequestLogsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

func (request ListWorkRequestLogsRequest) 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 ListWorkRequestLogsResponse

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

type ListWorkRequestLogsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For list pagination. When this header appears in the response, additional pages of results remain. For
    // important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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 (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

ListWorkRequestLogsSortByEnum Enum with underlying type: string

type ListWorkRequestLogsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

const (
    ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

type ListWorkRequestLogsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

const (
    ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
    ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

type ListWorkRequestsRequest struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
    WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`

    // A filter to return only the resources that match the given lifecycle state.
    Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
    ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For list pagination. The value of the opc-next-page response header from the previous
    // "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`).
    SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.
    SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

func (ListWorkRequestsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

func (request ListWorkRequestsRequest) 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 ListWorkRequestsResponse

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

type ListWorkRequestsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of WorkRequestSummaryCollection instances
    WorkRequestSummaryCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
    // important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

ListWorkRequestsSortByEnum Enum with underlying type: string

type ListWorkRequestsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

const (
    ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum

ListWorkRequestsSortOrderEnum Enum with underlying type: string

type ListWorkRequestsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

const (
    ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
    ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type ListWorkRequestsStatusEnum

ListWorkRequestsStatusEnum Enum with underlying type: string

type ListWorkRequestsStatusEnum string

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

const (
    ListWorkRequestsStatusAccepted       ListWorkRequestsStatusEnum = "ACCEPTED"
    ListWorkRequestsStatusInProgress     ListWorkRequestsStatusEnum = "IN_PROGRESS"
    ListWorkRequestsStatusWaiting        ListWorkRequestsStatusEnum = "WAITING"
    ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
    ListWorkRequestsStatusFailed         ListWorkRequestsStatusEnum = "FAILED"
    ListWorkRequestsStatusSucceeded      ListWorkRequestsStatusEnum = "SUCCEEDED"
    ListWorkRequestsStatusCanceling      ListWorkRequestsStatusEnum = "CANCELING"
    ListWorkRequestsStatusCanceled       ListWorkRequestsStatusEnum = "CANCELED"
)

func GetListWorkRequestsStatusEnumValues

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

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

type ListingSubscriptionSummary

ListingSubscriptionSummary The summary information about a Subscription.

type ListingSubscriptionSummary struct {

    // The subscription name. Must be unique within the compartment. This value can be updated.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The unique identifier of marketplace listing in Oracle Cloud Infrastructure.
    ProductId *string `mandatory:"false" json:"productId"`

    // The date and time the Subscription was started, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the Subscription was ended, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`

    // The current state of the Subscription.
    LifecycleState LifecycleStateEnumEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // A message that describes the current state of the Subscription in more detail. For example,
    // can be used to provide actionable information for a resource in the Failed state.
    LifecycleDetails LifecycleDetailsEnumEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // System tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (ListingSubscriptionSummary) String

func (m ListingSubscriptionSummary) String() string

func (ListingSubscriptionSummary) ValidateEnumValue

func (m ListingSubscriptionSummary) 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 ListingSubscriptionsCollection

ListingSubscriptionsCollection Results of a subscription search. Contains both SubscriptionSummary items and other information, such as metadata.

type ListingSubscriptionsCollection struct {

    // List of subscriptions for particular listing.
    Items []ListingSubscriptionSummary `mandatory:"true" json:"items"`
}

func (ListingSubscriptionsCollection) String

func (m ListingSubscriptionsCollection) String() string

func (ListingSubscriptionsCollection) ValidateEnumValue

func (m ListingSubscriptionsCollection) 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 ListingSubscriptionsRequest

ListingSubscriptionsRequest wrapper for the ListingSubscriptions operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListingSubscriptions.go.html to see an example of how to use ListingSubscriptionsRequest.

type ListingSubscriptionsRequest struct {

    // The unique identifier for the listing.
    ListingId *string `mandatory:"true" contributesTo:"query" name:"listingId"`

    // A filter to return only resources that match the given name.
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // The field to sort by. Only one sort order may be provided.
    SortBy ListingSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`).
    SortOrder ListingSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the opc-next-page response header from the previous
    // "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (ListingSubscriptionsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListingSubscriptionsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListingSubscriptionsRequest) RetryPolicy

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

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

func (ListingSubscriptionsRequest) String

func (request ListingSubscriptionsRequest) String() string

func (ListingSubscriptionsRequest) ValidateEnumValue

func (request ListingSubscriptionsRequest) 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 ListingSubscriptionsResponse

ListingSubscriptionsResponse wrapper for the ListingSubscriptions operation

type ListingSubscriptionsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of ListingSubscriptionsCollection instances
    ListingSubscriptionsCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
    // important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListingSubscriptionsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListingSubscriptionsResponse) String

func (response ListingSubscriptionsResponse) String() string

type ListingSubscriptionsSortByEnum

ListingSubscriptionsSortByEnum Enum with underlying type: string

type ListingSubscriptionsSortByEnum string

Set of constants representing the allowable values for ListingSubscriptionsSortByEnum

const (
    ListingSubscriptionsSortByTimecreated ListingSubscriptionsSortByEnum = "timeCreated"
    ListingSubscriptionsSortByDisplayname ListingSubscriptionsSortByEnum = "displayName"
    ListingSubscriptionsSortByProductid   ListingSubscriptionsSortByEnum = "productId"
)

func GetListingSubscriptionsSortByEnumValues

func GetListingSubscriptionsSortByEnumValues() []ListingSubscriptionsSortByEnum

GetListingSubscriptionsSortByEnumValues Enumerates the set of values for ListingSubscriptionsSortByEnum

func GetMappingListingSubscriptionsSortByEnum

func GetMappingListingSubscriptionsSortByEnum(val string) (ListingSubscriptionsSortByEnum, bool)

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

type ListingSubscriptionsSortOrderEnum

ListingSubscriptionsSortOrderEnum Enum with underlying type: string

type ListingSubscriptionsSortOrderEnum string

Set of constants representing the allowable values for ListingSubscriptionsSortOrderEnum

const (
    ListingSubscriptionsSortOrderAsc  ListingSubscriptionsSortOrderEnum = "ASC"
    ListingSubscriptionsSortOrderDesc ListingSubscriptionsSortOrderEnum = "DESC"
)

func GetListingSubscriptionsSortOrderEnumValues

func GetListingSubscriptionsSortOrderEnumValues() []ListingSubscriptionsSortOrderEnum

GetListingSubscriptionsSortOrderEnumValues Enumerates the set of values for ListingSubscriptionsSortOrderEnum

func GetMappingListingSubscriptionsSortOrderEnum

func GetMappingListingSubscriptionsSortOrderEnum(val string) (ListingSubscriptionsSortOrderEnum, bool)

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

type Meter

Meter Details provide by seller for activation of its product.

type Meter struct {

    // Name of meter.
    Name *string `mandatory:"true" json:"name"`

    // Tha rate of this sku meter.
    RateAllocation *float32 `mandatory:"true" json:"rateAllocation"`

    // Additional data give by sku.
    ExtendedMetadata []ExtendedMetadata `mandatory:"false" json:"extendedMetadata"`
}

func (Meter) String

func (m Meter) String() string

func (Meter) ValidateEnumValue

func (m Meter) 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 MetricTypeEnum

MetricTypeEnum Enum with underlying type: string

type MetricTypeEnum string

Set of constants representing the allowable values for MetricTypeEnum

const (
    MetricTypeOcpuHours     MetricTypeEnum = "OCPU_HOURS"
    MetricTypeInstanceHours MetricTypeEnum = "INSTANCE_HOURS"
    MetricTypeCoreHours     MetricTypeEnum = "CORE_HOURS"
    MetricTypeEach          MetricTypeEnum = "EACH"
)

func GetMappingMetricTypeEnum

func GetMappingMetricTypeEnum(val string) (MetricTypeEnum, bool)

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

func GetMetricTypeEnumValues

func GetMetricTypeEnumValues() []MetricTypeEnum

GetMetricTypeEnumValues Enumerates the set of values for MetricTypeEnum

type OperationStatusEnum

OperationStatusEnum Enum with underlying type: string

type OperationStatusEnum string

Set of constants representing the allowable values for OperationStatusEnum

const (
    OperationStatusAccepted       OperationStatusEnum = "ACCEPTED"
    OperationStatusInProgress     OperationStatusEnum = "IN_PROGRESS"
    OperationStatusWaiting        OperationStatusEnum = "WAITING"
    OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
    OperationStatusFailed         OperationStatusEnum = "FAILED"
    OperationStatusSucceeded      OperationStatusEnum = "SUCCEEDED"
    OperationStatusCanceling      OperationStatusEnum = "CANCELING"
    OperationStatusCanceled       OperationStatusEnum = "CANCELED"
)

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

OperationTypeEnum Enum with underlying type: string

type OperationTypeEnum string

Set of constants representing the allowable values for OperationTypeEnum

const (
    OperationTypeCreateSubscription           OperationTypeEnum = "CREATE_SUBSCRIPTION"
    OperationTypeUpdateSubscription           OperationTypeEnum = "UPDATE_SUBSCRIPTION"
    OperationTypeDeleteSubscription           OperationTypeEnum = "DELETE_SUBSCRIPTION"
    OperationTypeMoveSubscription             OperationTypeEnum = "MOVE_SUBSCRIPTION"
    OperationTypeSubmitSubscriptionUsageBatch OperationTypeEnum = "SUBMIT_SUBSCRIPTION_USAGE_BATCH"
)

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type Partner

Partner Marketplace publisher partner details.

type Partner struct {

    // The unique identifier of the marketplace publisher partner.
    Id *string `mandatory:"true" json:"id"`

    // The unique identifier of the compartment of partner.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The current lifecycle state of the marketplace publisher partner.
    LifecycleState PartnerLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The display name of marketplace publisher partner.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // System tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (Partner) String

func (m Partner) String() string

func (Partner) ValidateEnumValue

func (m Partner) 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 PartnerCollection

PartnerCollection Results of listing marketplace publisher partners.

type PartnerCollection struct {

    // The list of marketplace publisher partners.
    Items []PartnerSummary `mandatory:"true" json:"items"`
}

func (PartnerCollection) String

func (m PartnerCollection) String() string

func (PartnerCollection) ValidateEnumValue

func (m PartnerCollection) 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 PartnerIntegerationClient

PartnerIntegerationClient a client for PartnerIntegeration

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

func NewPartnerIntegerationClientWithConfigurationProvider

func NewPartnerIntegerationClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client PartnerIntegerationClient, err error)

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

func NewPartnerIntegerationClientWithOboToken

func NewPartnerIntegerationClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client PartnerIntegerationClient, err error)

NewPartnerIntegerationClientWithOboToken Creates a new default PartnerIntegeration 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 (PartnerIntegerationClient) ActivateSubscription

func (client PartnerIntegerationClient) ActivateSubscription(ctx context.Context, request ActivateSubscriptionRequest) (response ActivateSubscriptionResponse, err error)

ActivateSubscription Activates a subscription identified by the provided subscription ID and updates its status.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ActivateSubscription.go.html to see an example of how to use ActivateSubscription API. A default retry strategy applies to this operation ActivateSubscription()

func (*PartnerIntegerationClient) ConfigurationProvider

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

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

func (PartnerIntegerationClient) ListPartners

func (client PartnerIntegerationClient) ListPartners(ctx context.Context, request ListPartnersRequest) (response ListPartnersResponse, err error)

ListPartners Lists marketplace publisher partner info for a compartment.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListPartners.go.html to see an example of how to use ListPartners API. A default retry strategy applies to this operation ListPartners()

func (PartnerIntegerationClient) ListingSubscriptions

func (client PartnerIntegerationClient) ListingSubscriptions(ctx context.Context, request ListingSubscriptionsRequest) (response ListingSubscriptionsResponse, err error)

ListingSubscriptions Gets information about a Subscription.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListingSubscriptions.go.html to see an example of how to use ListingSubscriptions API. A default retry strategy applies to this operation ListingSubscriptions()

func (PartnerIntegerationClient) ResolveSubscription

func (client PartnerIntegerationClient) ResolveSubscription(ctx context.Context, request ResolveSubscriptionRequest) (response ResolveSubscriptionResponse, err error)

ResolveSubscription This API returns the subscription details by resolving JWT token to corresponding subscription and move its state to Pending Activation state.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ResolveSubscription.go.html to see an example of how to use ResolveSubscription API. A default retry strategy applies to this operation ResolveSubscription()

func (*PartnerIntegerationClient) SetRegion

func (client *PartnerIntegerationClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (PartnerIntegerationClient) SubmitSubscriptionUsageBatch

func (client PartnerIntegerationClient) SubmitSubscriptionUsageBatch(ctx context.Context, request SubmitSubscriptionUsageBatchRequest) (response SubmitSubscriptionUsageBatchResponse, err error)

SubmitSubscriptionUsageBatch Asynchronously submits a UTF-8 CSV usage file for marketplace offers. The file must not exceed 50 MB or 10,000 rows and must include required usage columns.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/SubmitSubscriptionUsageBatch.go.html to see an example of how to use SubmitSubscriptionUsageBatch API. A default retry strategy applies to this operation SubmitSubscriptionUsageBatch()

func (PartnerIntegerationClient) SubmitSubscriptionUsageRecords

func (client PartnerIntegerationClient) SubmitSubscriptionUsageRecords(ctx context.Context, request SubmitSubscriptionUsageRecordsRequest) (response SubmitSubscriptionUsageRecordsResponse, err error)

SubmitSubscriptionUsageRecords Synchronously submits usage records for marketplace offers. Each record must include `id`, `marketplaceOfferId`, `amount`, `currencyCode`, `timeUsageStarted`, `timeUsageEnded`, and `usageDimensionName`.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/SubmitSubscriptionUsageRecords.go.html to see an example of how to use SubmitSubscriptionUsageRecords API. A default retry strategy applies to this operation SubmitSubscriptionUsageRecords()

type PartnerLifecycleStateEnum

PartnerLifecycleStateEnum Enum with underlying type: string

type PartnerLifecycleStateEnum string

Set of constants representing the allowable values for PartnerLifecycleStateEnum

const (
    PartnerLifecycleStateActive  PartnerLifecycleStateEnum = "ACTIVE"
    PartnerLifecycleStateDeleted PartnerLifecycleStateEnum = "DELETED"
)

func GetMappingPartnerLifecycleStateEnum

func GetMappingPartnerLifecycleStateEnum(val string) (PartnerLifecycleStateEnum, bool)

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

func GetPartnerLifecycleStateEnumValues

func GetPartnerLifecycleStateEnumValues() []PartnerLifecycleStateEnum

GetPartnerLifecycleStateEnumValues Enumerates the set of values for PartnerLifecycleStateEnum

type PartnerSubscription

PartnerSubscription These api for partner to communicate to OCI.

type PartnerSubscription struct {

    // The unique identifier of the Subscription.
    SubscriptionId *string `mandatory:"true" json:"subscriptionId"`

    // The subscription name. Must be unique within the compartment. This value can be updated.
    DisplayName *string `mandatory:"false" json:"displayName"`

    PricingPlan *PricingPlan `mandatory:"false" json:"pricingPlan"`

    // The type of seller in SELF Service.
    SourceType SourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`

    // The unique OCID of the product, effectively functioning as the listing ID.
    ProductId *string `mandatory:"false" json:"productId"`

    // Whether subscription should be auto-renewed at the end of cycle.
    IsAutoRenew *bool `mandatory:"false" json:"isAutoRenew"`

    // Additional details that are specific for this subscription such as activation details.
    AdditionalDetails []ExtendedMetadata `mandatory:"false" json:"additionalDetails"`

    // The current state of the Subscription.
    LifecycleState LifecycleStateEnumEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // A message that describes the current state of the Subscription in more detail. For example,
    // can be used to provide actionable information for a resource in the Failed state.
    LifecycleDetails LifecycleDetailsEnumEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`

    // The date and time the Subscription was started, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the Subscription was ended, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`

    // The date and time the Subscription was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

    // The date and time the Subscription was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

func (PartnerSubscription) String

func (m PartnerSubscription) String() string

func (PartnerSubscription) ValidateEnumValue

func (m PartnerSubscription) 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 PartnerSummary

PartnerSummary Summary of a marketplace publisher partner.

type PartnerSummary struct {

    // The unique identifier of the marketplace publisher partner.
    Id *string `mandatory:"true" json:"id"`

    // The unique identifier of the compartment of partner.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The current lifecycle state of the marketplace publisher partner.
    LifecycleState PartnerLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The display name of marketplace publisher partner.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // System tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (PartnerSummary) String

func (m PartnerSummary) String() string

func (PartnerSummary) ValidateEnumValue

func (m PartnerSummary) 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 PricingPlan

PricingPlan A pricing plan details provided by the Publisher.

type PricingPlan struct {

    // The type of the subscription plan.
    PlanType PricingPlanPlanTypeEnum `mandatory:"true" json:"planType"`

    // The name of the subscription plan used to identify the plan.
    PlanName *string `mandatory:"true" json:"planName"`

    // Specifies the interval at which billing occurs for the subscription plan or usage dimension.
    BillingFrequency BillingFrequencyEnum `mandatory:"true" json:"billingFrequency"`

    // The pricing details of the subscription plan in various supported currencies.
    Rates []PricingRate `mandatory:"true" json:"rates"`

    // A detailed explanation of the subscription plan.
    PlanDescription *string `mandatory:"false" json:"planDescription"`

    // Specifies the duration of the subscription plan.
    PlanDuration PricingPlanPlanDurationEnum `mandatory:"false" json:"planDuration,omitempty"`

    // Metered usage dimensions associated with the pricing plan.
    Dimensions []UsageDimension `mandatory:"false" json:"dimensions"`
}

func (PricingPlan) String

func (m PricingPlan) String() string

func (PricingPlan) ValidateEnumValue

func (m PricingPlan) 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 PricingPlanPlanDurationEnum

PricingPlanPlanDurationEnum Enum with underlying type: string

type PricingPlanPlanDurationEnum string

Set of constants representing the allowable values for PricingPlanPlanDurationEnum

const (
    PricingPlanPlanDurationMonthly    PricingPlanPlanDurationEnum = "MONTHLY"
    PricingPlanPlanDurationQuarterly  PricingPlanPlanDurationEnum = "QUARTERLY"
    PricingPlanPlanDurationSemiAnnual PricingPlanPlanDurationEnum = "SEMI_ANNUAL"
    PricingPlanPlanDurationAnnual     PricingPlanPlanDurationEnum = "ANNUAL"
    PricingPlanPlanDurationBiennial   PricingPlanPlanDurationEnum = "BIENNIAL"
    PricingPlanPlanDurationTriennial  PricingPlanPlanDurationEnum = "TRIENNIAL"
)

func GetMappingPricingPlanPlanDurationEnum

func GetMappingPricingPlanPlanDurationEnum(val string) (PricingPlanPlanDurationEnum, bool)

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

func GetPricingPlanPlanDurationEnumValues

func GetPricingPlanPlanDurationEnumValues() []PricingPlanPlanDurationEnum

GetPricingPlanPlanDurationEnumValues Enumerates the set of values for PricingPlanPlanDurationEnum

type PricingPlanPlanTypeEnum

PricingPlanPlanTypeEnum Enum with underlying type: string

type PricingPlanPlanTypeEnum string

Set of constants representing the allowable values for PricingPlanPlanTypeEnum

const (
    PricingPlanPlanTypeFixed      PricingPlanPlanTypeEnum = "FIXED"
    PricingPlanPlanTypeUsageBased PricingPlanPlanTypeEnum = "USAGE_BASED"
    PricingPlanPlanTypeHybrid     PricingPlanPlanTypeEnum = "HYBRID"
)

func GetMappingPricingPlanPlanTypeEnum

func GetMappingPricingPlanPlanTypeEnum(val string) (PricingPlanPlanTypeEnum, bool)

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

func GetPricingPlanPlanTypeEnumValues

func GetPricingPlanPlanTypeEnumValues() []PricingPlanPlanTypeEnum

GetPricingPlanPlanTypeEnumValues Enumerates the set of values for PricingPlanPlanTypeEnum

type PricingRate

PricingRate A pricing plan rate provided by the Publisher.

type PricingRate struct {

    // The currency supported, in the format specified by ISO-4217
    Currency *string `mandatory:"true" json:"currency"`

    // The amount charged for the plan in the specified currency.
    Rate *float32 `mandatory:"true" json:"rate"`
}

func (PricingRate) String

func (m PricingRate) String() string

func (PricingRate) ValidateEnumValue

func (m PricingRate) 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 ResolveSubscriptionDetails

ResolveSubscriptionDetails Request model used to resolve and retrieve subscription details for a customer subscription, given a selfToken and the productId.

type ResolveSubscriptionDetails struct {

    // The base 64 encoded JWT token which is mapped to a particular subscription
    SelfToken *string `mandatory:"true" json:"selfToken"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the marketplace product listing.
    ProductId *string `mandatory:"true" json:"productId"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (ResolveSubscriptionDetails) String

func (m ResolveSubscriptionDetails) String() string

func (ResolveSubscriptionDetails) ValidateEnumValue

func (m ResolveSubscriptionDetails) 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 ResolveSubscriptionRequest

ResolveSubscriptionRequest wrapper for the ResolveSubscription operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ResolveSubscription.go.html to see an example of how to use ResolveSubscriptionRequest.

type ResolveSubscriptionRequest struct {

    // Details for the new Subscription.
    ResolveSubscriptionDetails `contributesTo:"body"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of running 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 removed from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
    // `if-match` parameter to the value of the etag from a previous GET or POST response for
    // that resource. The resource will be updated or deleted only if the etag you provide
    // matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

func (ResolveSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ResolveSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ResolveSubscriptionRequest) RetryPolicy

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

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

func (ResolveSubscriptionRequest) String

func (request ResolveSubscriptionRequest) String() string

func (ResolveSubscriptionRequest) ValidateEnumValue

func (request ResolveSubscriptionRequest) 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 ResolveSubscriptionResponse

ResolveSubscriptionResponse wrapper for the ResolveSubscription operation

type ResolveSubscriptionResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

func (ResolveSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ResolveSubscriptionResponse) String

func (response ResolveSubscriptionResponse) String() string

type SortOrderEnum

SortOrderEnum Enum with underlying type: string

type SortOrderEnum string

Set of constants representing the allowable values for SortOrderEnum

const (
    SortOrderAsc  SortOrderEnum = "ASC"
    SortOrderDesc SortOrderEnum = "DESC"
)

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type SourceTypeEnum

SourceTypeEnum Enum with underlying type: string

type SourceTypeEnum string

Set of constants representing the allowable values for SourceTypeEnum

const (
    SourceTypeOciNative  SourceTypeEnum = "OCI_NATIVE"
    SourceTypeThirdParty SourceTypeEnum = "THIRD_PARTY"
)

func GetMappingSourceTypeEnum

func GetMappingSourceTypeEnum(val string) (SourceTypeEnum, bool)

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

func GetSourceTypeEnumValues

func GetSourceTypeEnumValues() []SourceTypeEnum

GetSourceTypeEnumValues Enumerates the set of values for SourceTypeEnum

type SubmitSubscriptionUsageBatchRequest

SubmitSubscriptionUsageBatchRequest wrapper for the SubmitSubscriptionUsageBatch operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/SubmitSubscriptionUsageBatch.go.html to see an example of how to use SubmitSubscriptionUsageBatchRequest.

type SubmitSubscriptionUsageBatchRequest struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment associated with the usage records request.
    CompartmentId *string `mandatory:"true" contributesTo:"header" name:"compartment-id"`

    // UTF-8 CSV file with no more than 10,000 usage records and a maximum size of 50 MB.
    // Required columns are `MarketplaceOfferId`, `Id`, `Amount`, `CurrencyCode`,
    // `UsageStartTime`, `UsageEndTime`, and `UsageDimensionName`.
    // Optional columns are `ConsumedQuantity`, `CustomerTenancyId`,
    // `BillingIdentifier`, `ProductSku`, `UnitOfMeasure`, `UnitPrice`,
    // `ContractDuration`, and `AdditionalMetadata`.
    // When provided in CSV, `AdditionalMetadata` must be a JSON array of `ExtendedMetadata`
    // objects. `MarketplaceOfferId` must be a subscription or private offer OCID.
    SubmitSubscriptionUsageBatchDetails io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of running 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 removed from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (SubmitSubscriptionUsageBatchRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (SubmitSubscriptionUsageBatchRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (SubmitSubscriptionUsageBatchRequest) RetryPolicy

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

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

func (SubmitSubscriptionUsageBatchRequest) String

func (request SubmitSubscriptionUsageBatchRequest) String() string

func (SubmitSubscriptionUsageBatchRequest) ValidateEnumValue

func (request SubmitSubscriptionUsageBatchRequest) 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 SubmitSubscriptionUsageBatchResponse

SubmitSubscriptionUsageBatchResponse wrapper for the SubmitSubscriptionUsageBatch operation

type SubmitSubscriptionUsageBatchResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
    // Use GetWorkRequest with this ID to track the status of the request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // 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 (SubmitSubscriptionUsageBatchResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (SubmitSubscriptionUsageBatchResponse) String

func (response SubmitSubscriptionUsageBatchResponse) String() string

type SubmitSubscriptionUsageRecordsDetails

SubmitSubscriptionUsageRecordsDetails Request payload to submit one or more usage records for marketplace offers.

type SubmitSubscriptionUsageRecordsDetails struct {

    // The usage records to submit. The array must contain at least one record and no more than 100 records.
    SubscriptionUsageRecords []CreateSubscriptionUsageRecordDetails `mandatory:"true" json:"subscriptionUsageRecords"`
}

func (SubmitSubscriptionUsageRecordsDetails) String

func (m SubmitSubscriptionUsageRecordsDetails) String() string

func (SubmitSubscriptionUsageRecordsDetails) ValidateEnumValue

func (m SubmitSubscriptionUsageRecordsDetails) 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 SubmitSubscriptionUsageRecordsRequest

SubmitSubscriptionUsageRecordsRequest wrapper for the SubmitSubscriptionUsageRecords operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/SubmitSubscriptionUsageRecords.go.html to see an example of how to use SubmitSubscriptionUsageRecordsRequest.

type SubmitSubscriptionUsageRecordsRequest struct {

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment associated with the usage records request.
    CompartmentId *string `mandatory:"true" contributesTo:"header" name:"compartment-id"`

    // Usage records to submit for marketplace offers.
    SubmitSubscriptionUsageRecordsDetails `contributesTo:"body"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of running 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 removed from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (SubmitSubscriptionUsageRecordsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (SubmitSubscriptionUsageRecordsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (SubmitSubscriptionUsageRecordsRequest) RetryPolicy

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

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

func (SubmitSubscriptionUsageRecordsRequest) String

func (request SubmitSubscriptionUsageRecordsRequest) String() string

func (SubmitSubscriptionUsageRecordsRequest) ValidateEnumValue

func (request SubmitSubscriptionUsageRecordsRequest) 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 SubmitSubscriptionUsageRecordsResponse

SubmitSubscriptionUsageRecordsResponse wrapper for the SubmitSubscriptionUsageRecords operation

type SubmitSubscriptionUsageRecordsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (SubmitSubscriptionUsageRecordsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (SubmitSubscriptionUsageRecordsResponse) String

func (response SubmitSubscriptionUsageRecordsResponse) String() string

type Subscription

Subscription The model for a listing subscription.

type Subscription struct {

    // The unique identifier for the subscription within a specific compartment.
    Id *string `mandatory:"true" json:"id"`

    // The subscription name. Must be unique within the compartment. This value can be updated.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The unique identifier for the compartment where the subscription was purchased.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The unique identifier for the tenant where the subscription was purchased.
    TenantId *string `mandatory:"true" json:"tenantId"`

    // The date and time the Subscription was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The current lifecycle state of the Subscription.
    LifecycleState LifecycleStateEnumEnum `mandatory:"true" json:"lifecycleState"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

    SubscriptionDetails *SubscriptionDetails `mandatory:"false" json:"subscriptionDetails"`

    // The OCID that identifies the seller within the platform.
    SellerId *string `mandatory:"false" json:"sellerId"`

    // The type of seller in SELF Service.
    SourceType SourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`

    // The unique OCID of the product, effectively functioning as the listing ID.
    ProductId *string `mandatory:"false" json:"productId"`

    // Additional details that are specific for this subscription such as activation details.
    AdditionalDetails []ExtendedMetadata `mandatory:"false" json:"additionalDetails"`

    // The realm from where customer is buying the subscription.
    Realm *string `mandatory:"false" json:"realm"`

    // The region from where customer is buying the subscription.
    Region *string `mandatory:"false" json:"region"`

    // The date and time the Subscription was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    // The date and time the Subscription was started, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the Subscription was ended, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`

    // A message that describes the current state of the Subscription in more detail. For example,
    // can be used to provide actionable information for a resource in the Failed state.
    LifecycleDetails LifecycleDetailsEnumEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`

    // System tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (Subscription) String

func (m Subscription) String() string

func (Subscription) ValidateEnumValue

func (m Subscription) 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

SubscriptionClient a client for Subscription

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

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

func (client SubscriptionClient) CancelSubscription(ctx context.Context, request CancelSubscriptionRequest) (response CancelSubscriptionResponse, err error)

CancelSubscription Requests cancellation of a Subscription. The subscription transitions to PendingCancellation and remains active until the end of the current billing cycle, at which point it transitions to Canceled. The subscription must be in the Active state to be canceled.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/CancelSubscription.go.html to see an example of how to use CancelSubscription API. A default retry strategy applies to this operation CancelSubscription()

func (SubscriptionClient) CancelWorkRequest

func (client SubscriptionClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)

CancelWorkRequest Cancels a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()

func (SubscriptionClient) ChangeSubscriptionCompartment

func (client SubscriptionClient) ChangeSubscriptionCompartment(ctx context.Context, request ChangeSubscriptionCompartmentRequest) (response ChangeSubscriptionCompartmentResponse, err error)

ChangeSubscriptionCompartment Moves a Subscription into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ChangeSubscriptionCompartment.go.html to see an example of how to use ChangeSubscriptionCompartment API. A default retry strategy applies to this operation ChangeSubscriptionCompartment()

func (*SubscriptionClient) ConfigurationProvider

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

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

func (SubscriptionClient) CreateSubscription

func (client SubscriptionClient) CreateSubscription(ctx context.Context, request CreateSubscriptionRequest) (response CreateSubscriptionResponse, err error)

CreateSubscription Creates a Subscription.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/CreateSubscription.go.html to see an example of how to use CreateSubscription API. A default retry strategy applies to this operation CreateSubscription()

func (SubscriptionClient) DeleteSubscription

func (client SubscriptionClient) DeleteSubscription(ctx context.Context, request DeleteSubscriptionRequest) (response DeleteSubscriptionResponse, err error)

DeleteSubscription Deletes a Subscription.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/DeleteSubscription.go.html to see an example of how to use DeleteSubscription API. A default retry strategy applies to this operation DeleteSubscription()

func (SubscriptionClient) GetSubscription

func (client SubscriptionClient) GetSubscription(ctx context.Context, request GetSubscriptionRequest) (response GetSubscriptionResponse, err error)

GetSubscription Gets information about a Subscription.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetSubscription.go.html to see an example of how to use GetSubscription API. A default retry strategy applies to this operation GetSubscription()

func (SubscriptionClient) GetSubscriptionToken

func (client SubscriptionClient) GetSubscriptionToken(ctx context.Context, request GetSubscriptionTokenRequest) (response GetSubscriptionTokenResponse, err error)

GetSubscriptionToken Gets a token of Subscriptions.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetSubscriptionToken.go.html to see an example of how to use GetSubscriptionToken API. A default retry strategy applies to this operation GetSubscriptionToken()

func (SubscriptionClient) GetWorkRequest

func (client SubscriptionClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Gets the details of a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

func (SubscriptionClient) ListSubscriptions

func (client SubscriptionClient) ListSubscriptions(ctx context.Context, request ListSubscriptionsRequest) (response ListSubscriptionsResponse, err error)

ListSubscriptions Lists the subscriptions which have been created in the specified compartment. You can filter results by specifying query parameters.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListSubscriptions.go.html to see an example of how to use ListSubscriptions API. A default retry strategy applies to this operation ListSubscriptions()

func (SubscriptionClient) ListWorkRequestErrors

func (client SubscriptionClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Lists the errors for a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()

func (SubscriptionClient) ListWorkRequestLogs

func (client SubscriptionClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Lists the logs for a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()

func (SubscriptionClient) ListWorkRequests

func (client SubscriptionClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists the work requests in a compartment.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (*SubscriptionClient) SetRegion

func (client *SubscriptionClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (SubscriptionClient) UpdateSubscription

func (client SubscriptionClient) UpdateSubscription(ctx context.Context, request UpdateSubscriptionRequest) (response UpdateSubscriptionResponse, err error)

UpdateSubscription Updates a Subscription.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/UpdateSubscription.go.html to see an example of how to use UpdateSubscription API. A default retry strategy applies to this operation UpdateSubscription()

type SubscriptionCollection

SubscriptionCollection Results of a subscription search. Contains both SubscriptionSummary items and other information, such as metadata.

type SubscriptionCollection struct {

    // List of subscriptions.
    Items []SubscriptionSummary `mandatory:"true" json:"items"`
}

func (SubscriptionCollection) String

func (m SubscriptionCollection) String() string

func (SubscriptionCollection) ValidateEnumValue

func (m SubscriptionCollection) 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 SubscriptionDetails

SubscriptionDetails The details of a subscription

type SubscriptionDetails struct {
    PricingPlan *PricingPlan `mandatory:"true" json:"pricingPlan"`

    // The activation link given by the partner.
    PartnerRegistrationUrl *string `mandatory:"true" json:"partnerRegistrationUrl"`

    // Billing details associated with the subscription plan and its usage dimensions.
    BillingDetails []BillingDetails `mandatory:"true" json:"billingDetails"`

    // The currency supported, in the format specified by ISO-4217
    Currency *string `mandatory:"false" json:"currency"`

    // Tha amount for the currency type.
    Amount *float32 `mandatory:"false" json:"amount"`

    // Whether subscription should be auto-renewed at the end of cycle.
    IsAutoRenew *bool `mandatory:"false" json:"isAutoRenew"`
}

func (SubscriptionDetails) String

func (m SubscriptionDetails) String() string

func (SubscriptionDetails) ValidateEnumValue

func (m SubscriptionDetails) 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

SubscriptionSummary The model for a summary of a subscription.

type SubscriptionSummary struct {

    // The unique identifier for the subscription within a specific compartment.
    Id *string `mandatory:"true" json:"id"`

    // The subscription name. Must be unique within the compartment. This value can be updated.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The unique identifier for the compartment where subscription was created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The unique identifier for the tenant where the subscription was purchased.
    TenantId *string `mandatory:"true" json:"tenantId"`

    // The date and time the Subscription was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // A message that describes the current state of the Subscription in more detail. For example,
    // can be used to provide actionable information for a resource in the Failed state.
    LifecycleDetails LifecycleDetailsEnumEnum `mandatory:"true" json:"lifecycleDetails"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

    SubscriptionDetails *SubscriptionDetails `mandatory:"false" json:"subscriptionDetails"`

    // The OCID that identifies the seller within the platform.
    SellerId *string `mandatory:"false" json:"sellerId"`

    // The unique OCID of the product, effectively functioning as the listing ID.
    ProductId *string `mandatory:"false" json:"productId"`

    // The date and time the Subscription was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    // The date and time the Subscription was started, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the Subscription was ended, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
    // Example: `2016-08-25T21:10:29.600Z`
    TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`

    // The current state of the Subscription.
    LifecycleState LifecycleStateEnumEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // System tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

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

type SubscriptionToken

SubscriptionToken The base 64 encoded JWT token which is mapped to a particular subscription.

type SubscriptionToken struct {

    // JWT token of subscriptions.
    Token *string `mandatory:"true" json:"token"`

    // The unique identifier for the subscription within a specific compartment.
    SubscriptionId *string `mandatory:"false" json:"subscriptionId"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // System tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (SubscriptionToken) String

func (m SubscriptionToken) String() string

func (SubscriptionToken) ValidateEnumValue

func (m SubscriptionToken) 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 UpdateSubscriptionDetails

UpdateSubscriptionDetails The data to update a Subscription.

type UpdateSubscriptionDetails struct {

    // The subscription name. Must be unique within the compartment. This value can be updated.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateSubscriptionDetails) String

func (m UpdateSubscriptionDetails) String() string

func (UpdateSubscriptionDetails) ValidateEnumValue

func (m UpdateSubscriptionDetails) 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 UpdateSubscriptionRequest

UpdateSubscriptionRequest wrapper for the UpdateSubscription operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/self/UpdateSubscription.go.html to see an example of how to use UpdateSubscriptionRequest.

type UpdateSubscriptionRequest struct {

    // The unique identifier for the subscription.
    SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

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

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

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    // The only valid characters for request IDs are letters, numbers,
    // underscore, and dash.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

func (UpdateSubscriptionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateSubscriptionRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateSubscriptionRequest) RetryPolicy

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

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

func (UpdateSubscriptionRequest) String

func (request UpdateSubscriptionRequest) String() string

func (UpdateSubscriptionRequest) ValidateEnumValue

func (request UpdateSubscriptionRequest) 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 UpdateSubscriptionResponse

UpdateSubscriptionResponse wrapper for the UpdateSubscription operation

type UpdateSubscriptionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
    // Use GetWorkRequest with this ID to track the status of the request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // 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 (UpdateSubscriptionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateSubscriptionResponse) String

func (response UpdateSubscriptionResponse) String() string

type UsageDimension

UsageDimension A metered usage dimension associated with a usage-based or hybrid pricing plan.

type UsageDimension struct {

    // The name of the usage dimension.
    DimensionName *string `mandatory:"true" json:"dimensionName"`

    // The stable key used internally to map this usage dimension to billing details.
    DimensionKey *string `mandatory:"true" json:"dimensionKey"`

    // A detailed explanation of the usage dimension.
    DimensionDescription *string `mandatory:"true" json:"dimensionDescription"`

    // The metric type in which usage is measured.
    MetricType MetricTypeEnum `mandatory:"true" json:"metricType"`

    // Specifies the interval at which the usage dimension is billed.
    DimensionBillingFrequency BillingFrequencyEnum `mandatory:"true" json:"dimensionBillingFrequency"`

    // Dimension-level rates in various supported currencies.
    Rates []PricingRate `mandatory:"true" json:"rates"`

    // Quantity included in the base fee for hybrid plans.
    IncludedQuantity *float32 `mandatory:"false" json:"includedQuantity"`
}

func (UsageDimension) String

func (m UsageDimension) String() string

func (UsageDimension) ValidateEnumValue

func (m UsageDimension) 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 WorkRequest

WorkRequest An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.

type WorkRequest struct {

    // The asynchronous operation tracked by this work request.
    OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

    // The status of the work request.
    Status OperationStatusEnum `mandatory:"true" json:"status"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
    Id *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The resources that are affected by the work request.
    Resources []WorkRequestResource `mandatory:"true" json:"resources"`

    // Shows the progress of the operation tracked by the work request, as a percentage of the total work
    // that must be performed.
    PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

    // The date and time the work request was created, in the format defined by
    // RFC 3339 (https://tools.ietf.org/html/rfc3339).
    TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

    // The date and time the work request was started, in the format defined by
    // RFC 3339 (https://tools.ietf.org/html/rfc3339).
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the work request was finished, in the format defined by
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
    TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

    // The date and time the work request was updated, in the format defined by
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

func (m WorkRequest) 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 WorkRequestError

WorkRequestError An error encountered while performing an operation that is tracked by a work request.

type WorkRequestError struct {

    // A machine-usable code for the error that occurred. For a list of error codes, see
    // API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
    Code *string `mandatory:"true" json:"code"`

    // A human-readable error message.
    Message *string `mandatory:"true" json:"message"`

    // The date and time the error occurred, in the format defined by
    // RFC 3339 (https://tools.ietf.org/html/rfc3339).
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

func (m WorkRequestError) 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 WorkRequestErrorCollection

WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.

type WorkRequestErrorCollection struct {

    // A list of work request errors.
    Items []WorkRequestError `mandatory:"true" json:"items"`
}

func (WorkRequestErrorCollection) String

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue

func (m WorkRequestErrorCollection) 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 WorkRequestLogEntry

WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.

type WorkRequestLogEntry struct {

    // A human-readable log message.
    Message *string `mandatory:"true" json:"message"`

    // The date and time the log message was written, in the format defined by
    // RFC 3339 (https://tools.ietf.org/html/rfc3339).
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

func (m WorkRequestLogEntry) 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 WorkRequestLogEntryCollection

WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.

type WorkRequestLogEntryCollection struct {

    // A list of work request log entries.
    Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

func (WorkRequestLogEntryCollection) String

func (m WorkRequestLogEntryCollection) String() string

func (WorkRequestLogEntryCollection) ValidateEnumValue

func (m WorkRequestLogEntryCollection) 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 WorkRequestResource

WorkRequestResource A resource created or operated on by a work request.

type WorkRequestResource struct {

    // The resource type that the work request affects.
    EntityType *string `mandatory:"true" json:"entityType"`

    // The way in which this resource is affected by the operation tracked in the work request.
    // A resource being created, updated, or deleted remains in the IN_PROGRESS state until
    // work is complete for that resource, at which point it transitions to CREATED, UPDATED,
    // or DELETED, respectively.
    ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`

    // An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
    Identifier *string `mandatory:"true" json:"identifier"`

    // The URI path that you can use for a GET request to access the resource metadata.
    EntityUri *string `mandatory:"false" json:"entityUri"`

    // Additional information that helps to explain the resource.
    Metadata map[string]string `mandatory:"false" json:"metadata"`
}

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

func (m WorkRequestResource) 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 WorkRequestResourceMetadataKeyEnum

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string

type WorkRequestResourceMetadataKeyEnum string

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

const (
    WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)

func GetMappingWorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

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

func GetWorkRequestResourceMetadataKeyEnumValues

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary

WorkRequestSummary Summary information about an asynchronous work request.

type WorkRequestSummary struct {

    // The asynchronous operation tracked by this work request.
    OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

    // The status of the work request.
    Status OperationStatusEnum `mandatory:"true" json:"status"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
    Id *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The resources that are affected by this work request.
    Resources []WorkRequestResource `mandatory:"true" json:"resources"`

    // Shows the progress of the operation tracked by the work request, as a percentage of the total work
    // that must be performed.
    PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

    // The date and time the work request was created, in the format defined by
    // RFC 3339 (https://tools.ietf.org/html/rfc3339).
    TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

    // The date and time the work request was started, in the format defined by
    // RFC 3339 (https://tools.ietf.org/html/rfc3339).
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the work request was finished, in the format defined by
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
    TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

    // The date and time the work request was updated, in the format defined by
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

func (m WorkRequestSummary) 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 WorkRequestSummaryCollection

WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.

type WorkRequestSummaryCollection struct {

    // A list of work requests.
    Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

func (WorkRequestSummaryCollection) String

func (m WorkRequestSummaryCollection) String() string

func (WorkRequestSummaryCollection) ValidateEnumValue

func (m WorkRequestSummaryCollection) 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