...

Package osuborganizationsubscription

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

Overview ▾

Index ▾

func GetListOrganizationSubscriptionsSortByEnumStringValues() []string
func GetListOrganizationSubscriptionsSortOrderEnumStringValues() []string
type Currency
    func (m Currency) String() string
    func (m Currency) ValidateEnumValue() (bool, error)
type ListOrganizationSubscriptionsRequest
    func (request ListOrganizationSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListOrganizationSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListOrganizationSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListOrganizationSubscriptionsRequest) String() string
    func (request ListOrganizationSubscriptionsRequest) ValidateEnumValue() (bool, error)
type ListOrganizationSubscriptionsResponse
    func (response ListOrganizationSubscriptionsResponse) HTTPResponse() *http.Response
    func (response ListOrganizationSubscriptionsResponse) String() string
type ListOrganizationSubscriptionsSortByEnum
    func GetListOrganizationSubscriptionsSortByEnumValues() []ListOrganizationSubscriptionsSortByEnum
    func GetMappingListOrganizationSubscriptionsSortByEnum(val string) (ListOrganizationSubscriptionsSortByEnum, bool)
type ListOrganizationSubscriptionsSortOrderEnum
    func GetListOrganizationSubscriptionsSortOrderEnumValues() []ListOrganizationSubscriptionsSortOrderEnum
    func GetMappingListOrganizationSubscriptionsSortOrderEnum(val string) (ListOrganizationSubscriptionsSortOrderEnum, bool)
type OrganizationSubscriptionClient
    func NewOrganizationSubscriptionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OrganizationSubscriptionClient, err error)
    func NewOrganizationSubscriptionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OrganizationSubscriptionClient, err error)
    func (client *OrganizationSubscriptionClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client OrganizationSubscriptionClient) ListOrganizationSubscriptions(ctx context.Context, request ListOrganizationSubscriptionsRequest) (response ListOrganizationSubscriptionsResponse, err error)
    func (client *OrganizationSubscriptionClient) SetRegion(region string)
type SubscriptionSummary
    func (m SubscriptionSummary) String() string
    func (m SubscriptionSummary) ValidateEnumValue() (bool, error)

Package files

currency.go list_organization_subscriptions_request_response.go osuborganizationsubscription_organizationsubscription_client.go subscription_summary.go

func GetListOrganizationSubscriptionsSortByEnumStringValues

func GetListOrganizationSubscriptionsSortByEnumStringValues() []string

GetListOrganizationSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListOrganizationSubscriptionsSortByEnum

func GetListOrganizationSubscriptionsSortOrderEnumStringValues

func GetListOrganizationSubscriptionsSortOrderEnumStringValues() []string

GetListOrganizationSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListOrganizationSubscriptionsSortOrderEnum

type Currency

Currency Currency details

type Currency struct {

    // Currency Code
    IsoCode *string `mandatory:"true" json:"isoCode"`

    // Currency name
    Name *string `mandatory:"false" json:"name"`

    // Standard Precision of the Currency
    StdPrecision *int64 `mandatory:"false" json:"stdPrecision"`
}

func (Currency) String

func (m Currency) String() string

func (Currency) ValidateEnumValue

func (m Currency) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListOrganizationSubscriptionsRequest

ListOrganizationSubscriptionsRequest wrapper for the ListOrganizationSubscriptions operation

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/osuborganizationsubscription/ListOrganizationSubscriptions.go.html to see an example of how to use ListOrganizationSubscriptionsRequest.

type ListOrganizationSubscriptionsRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // Comma separated list of subscription ids
    SubscriptionIds *string `mandatory:"true" contributesTo:"query" name:"subscriptionIds"`

    // The maximum number of items to return in a paginated "List" call. Default: (`50`)
    // Example: `500`
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` response header from the previous "List" call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

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

    // The field to sort by. You can provide one sort order (`sortOrder`).
    SortBy ListOrganizationSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

    // The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
    XOneOriginRegion *string `mandatory:"false" contributesTo:"header" name:"x-one-origin-region"`

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

func (ListOrganizationSubscriptionsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListOrganizationSubscriptionsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListOrganizationSubscriptionsRequest) RetryPolicy

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

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

func (ListOrganizationSubscriptionsRequest) String

func (request ListOrganizationSubscriptionsRequest) String() string

func (ListOrganizationSubscriptionsRequest) ValidateEnumValue

func (request ListOrganizationSubscriptionsRequest) 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 ListOrganizationSubscriptionsResponse

ListOrganizationSubscriptionsResponse wrapper for the ListOrganizationSubscriptions operation

type ListOrganizationSubscriptionsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []SubscriptionSummary instances
    Items []SubscriptionSummary `presentIn:"body"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then a partial list might have been returned. Include this value as the `page` parameter for the
    // subsequent GET request to get the next batch of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

func (ListOrganizationSubscriptionsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListOrganizationSubscriptionsResponse) String

func (response ListOrganizationSubscriptionsResponse) String() string

type ListOrganizationSubscriptionsSortByEnum

ListOrganizationSubscriptionsSortByEnum Enum with underlying type: string

type ListOrganizationSubscriptionsSortByEnum string

Set of constants representing the allowable values for ListOrganizationSubscriptionsSortByEnum

const (
    ListOrganizationSubscriptionsSortBySubscriptionid ListOrganizationSubscriptionsSortByEnum = "SUBSCRIPTIONID"
    ListOrganizationSubscriptionsSortByTimestart      ListOrganizationSubscriptionsSortByEnum = "TIMESTART"
)

func GetListOrganizationSubscriptionsSortByEnumValues

func GetListOrganizationSubscriptionsSortByEnumValues() []ListOrganizationSubscriptionsSortByEnum

GetListOrganizationSubscriptionsSortByEnumValues Enumerates the set of values for ListOrganizationSubscriptionsSortByEnum

func GetMappingListOrganizationSubscriptionsSortByEnum

func GetMappingListOrganizationSubscriptionsSortByEnum(val string) (ListOrganizationSubscriptionsSortByEnum, bool)

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

type ListOrganizationSubscriptionsSortOrderEnum

ListOrganizationSubscriptionsSortOrderEnum Enum with underlying type: string

type ListOrganizationSubscriptionsSortOrderEnum string

Set of constants representing the allowable values for ListOrganizationSubscriptionsSortOrderEnum

const (
    ListOrganizationSubscriptionsSortOrderAsc  ListOrganizationSubscriptionsSortOrderEnum = "ASC"
    ListOrganizationSubscriptionsSortOrderDesc ListOrganizationSubscriptionsSortOrderEnum = "DESC"
)

func GetListOrganizationSubscriptionsSortOrderEnumValues

func GetListOrganizationSubscriptionsSortOrderEnumValues() []ListOrganizationSubscriptionsSortOrderEnum

GetListOrganizationSubscriptionsSortOrderEnumValues Enumerates the set of values for ListOrganizationSubscriptionsSortOrderEnum

func GetMappingListOrganizationSubscriptionsSortOrderEnum

func GetMappingListOrganizationSubscriptionsSortOrderEnum(val string) (ListOrganizationSubscriptionsSortOrderEnum, bool)

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

type OrganizationSubscriptionClient

OrganizationSubscriptionClient a client for OrganizationSubscription

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

func NewOrganizationSubscriptionClientWithConfigurationProvider

func NewOrganizationSubscriptionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OrganizationSubscriptionClient, err error)

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

func NewOrganizationSubscriptionClientWithOboToken

func NewOrganizationSubscriptionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OrganizationSubscriptionClient, err error)

NewOrganizationSubscriptionClientWithOboToken Creates a new default OrganizationSubscription 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 (*OrganizationSubscriptionClient) ConfigurationProvider

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

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

func (OrganizationSubscriptionClient) ListOrganizationSubscriptions

func (client OrganizationSubscriptionClient) ListOrganizationSubscriptions(ctx context.Context, request ListOrganizationSubscriptionsRequest) (response ListOrganizationSubscriptionsResponse, err error)

ListOrganizationSubscriptions API that returns data for the list of subscription ids returned from Organizations API

# See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.59.0/osuborganizationsubscription/ListOrganizationSubscriptions.go.html to see an example of how to use ListOrganizationSubscriptions API.

func (*OrganizationSubscriptionClient) SetRegion

func (client *OrganizationSubscriptionClient) SetRegion(region string)

SetRegion overrides the region of this client.

type SubscriptionSummary

SubscriptionSummary Subscription summary

type SubscriptionSummary struct {

    // SPM internal Subscription ID
    Id *string `mandatory:"true" json:"id"`

    // Customer friendly service name provided by PRG
    ServiceName *string `mandatory:"false" json:"serviceName"`

    // Subscription Type i.e. IAAS,SAAS,PAAS
    Type *string `mandatory:"false" json:"type"`

    // Status of the plan
    Status *string `mandatory:"false" json:"status"`

    // Represents the date when the first service of the subscription was activated
    TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`

    // Represents the date when the last service of the subscription ends
    TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`

    Currency *Currency `mandatory:"false" json:"currency"`

    // Total aggregate TCLV of all lines for the subscription including expired, active, and signed
    TotalValue *string `mandatory:"false" json:"totalValue"`
}

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