usage

package
v65.67.1 Latest Latest
Warning

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

 Go to latest Published: Jun 11, 2024 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetListProductsProducttypeEnumStringValues 

func GetListProductsProducttypeEnumStringValues() []string

GetListProductsProducttypeEnumStringValues Enumerates the set of values in String for ListProductsProducttypeEnum

func GetListProductsSortByEnumStringValues 

func GetListProductsSortByEnumStringValues() []string

GetListProductsSortByEnumStringValues Enumerates the set of values in String for ListProductsSortByEnum

func GetListProductsSortOrderEnumStringValues 

func GetListProductsSortOrderEnumStringValues() []string

GetListProductsSortOrderEnumStringValues Enumerates the set of values in String for ListProductsSortOrderEnum

func GetListRedeemableUsersSortByEnumStringValues 

func GetListRedeemableUsersSortByEnumStringValues() []string

GetListRedeemableUsersSortByEnumStringValues Enumerates the set of values in String for ListRedeemableUsersSortByEnum

func GetListRedeemableUsersSortOrderEnumStringValues 

func GetListRedeemableUsersSortOrderEnumStringValues() []string

GetListRedeemableUsersSortOrderEnumStringValues Enumerates the set of values in String for ListRedeemableUsersSortOrderEnum

func GetListRedemptionsSortByEnumStringValues added in v65.18.0 

func GetListRedemptionsSortByEnumStringValues() []string

GetListRedemptionsSortByEnumStringValues Enumerates the set of values in String for ListRedemptionsSortByEnum

func GetListRedemptionsSortOrderEnumStringValues added in v65.18.0 

func GetListRedemptionsSortOrderEnumStringValues() []string

GetListRedemptionsSortOrderEnumStringValues Enumerates the set of values in String for ListRedemptionsSortOrderEnum

func GetListResourceQuotaSortByEnumStringValues added in v65.41.0 

func GetListResourceQuotaSortByEnumStringValues() []string

GetListResourceQuotaSortByEnumStringValues Enumerates the set of values in String for ListResourceQuotaSortByEnum

func GetListResourceQuotaSortOrderEnumStringValues added in v65.41.0 

func GetListResourceQuotaSortOrderEnumStringValues() []string

GetListResourceQuotaSortOrderEnumStringValues Enumerates the set of values in String for ListResourceQuotaSortOrderEnum

func GetListResourcesSortByEnumStringValues added in v65.41.0 

func GetListResourcesSortByEnumStringValues() []string

GetListResourcesSortByEnumStringValues Enumerates the set of values in String for ListResourcesSortByEnum

func GetListResourcesSortOrderEnumStringValues added in v65.41.0 

func GetListResourcesSortOrderEnumStringValues() []string

GetListResourcesSortOrderEnumStringValues Enumerates the set of values in String for ListResourcesSortOrderEnum

func GetListUsageLimitsSortByEnumStringValues added in v65.41.0 

func GetListUsageLimitsSortByEnumStringValues() []string

GetListUsageLimitsSortByEnumStringValues Enumerates the set of values in String for ListUsageLimitsSortByEnum

func GetListUsageLimitsSortOrderEnumStringValues added in v65.41.0 

func GetListUsageLimitsSortOrderEnumStringValues() []string

GetListUsageLimitsSortOrderEnumStringValues Enumerates the set of values in String for ListUsageLimitsSortOrderEnum

func GetResourceSummaryUsageDataTypeEnumStringValues added in v65.41.0 

func GetResourceSummaryUsageDataTypeEnumStringValues() []string

GetResourceSummaryUsageDataTypeEnumStringValues Enumerates the set of values in String for ResourceSummaryUsageDataTypeEnum

func GetUsageLimitSummaryActionEnumStringValues added in v65.41.0 

func GetUsageLimitSummaryActionEnumStringValues() []string

GetUsageLimitSummaryActionEnumStringValues Enumerates the set of values in String for UsageLimitSummaryActionEnum

func GetUsageLimitSummaryLifecycleStateEnumStringValues added in v65.41.0 

func GetUsageLimitSummaryLifecycleStateEnumStringValues() []string

GetUsageLimitSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for UsageLimitSummaryLifecycleStateEnum

func GetUsageLimitSummaryLimitTypeEnumStringValues added in v65.41.0 

func GetUsageLimitSummaryLimitTypeEnumStringValues() []string

GetUsageLimitSummaryLimitTypeEnumStringValues Enumerates the set of values in String for UsageLimitSummaryLimitTypeEnum

func GetUsageLimitSummaryValueTypeEnumStringValues added in v65.41.0 

func GetUsageLimitSummaryValueTypeEnumStringValues() []string

GetUsageLimitSummaryValueTypeEnumStringValues Enumerates the set of values in String for UsageLimitSummaryValueTypeEnum

Types

type CreateRedeemableUserDetails 

type CreateRedeemableUserDetails struct {

	// The list of new user to be added to the list of user that can redeem rewards.
	Items []RedeemableUser `mandatory:"false" json:"items"`
}

CreateRedeemableUserDetails A list of new user to be added to the list of user that can redeem rewards.

func (CreateRedeemableUserDetails) String 

func (m CreateRedeemableUserDetails) String() string

func (CreateRedeemableUserDetails) ValidateEnumValue 

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

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

type CreateRedeemableUserRequest 

type CreateRedeemableUserRequest struct {

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

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

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

	// The user ID of the person to send a copy of an email.
	UserId *string `mandatory:"false" contributesTo:"query" name:"userId"`

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

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error, without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

CreateRedeemableUserRequest wrapper for the CreateRedeemableUser operation

See also

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

func (CreateRedeemableUserRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateRedeemableUserRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateRedeemableUserRequest) RetryPolicy 

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

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

func (CreateRedeemableUserRequest) String 

func (request CreateRedeemableUserRequest) String() string

func (CreateRedeemableUserRequest) ValidateEnumValue 

func (request CreateRedeemableUserRequest) ValidateEnumValue() (bool, error)

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

type CreateRedeemableUserResponse 

type CreateRedeemableUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateRedeemableUserResponse wrapper for the CreateRedeemableUser operation

func (CreateRedeemableUserResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateRedeemableUserResponse) String 

func (response CreateRedeemableUserResponse) String() string

type DeleteRedeemableUserRequest 

type DeleteRedeemableUserRequest struct {

	// The email ID that needs to be deleted.
	EmailId *string `mandatory:"true" contributesTo:"query" name:"emailId"`

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

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

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

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

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

DeleteRedeemableUserRequest wrapper for the DeleteRedeemableUser operation

See also

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

func (DeleteRedeemableUserRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteRedeemableUserRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteRedeemableUserRequest) RetryPolicy 

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

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

func (DeleteRedeemableUserRequest) String 

func (request DeleteRedeemableUserRequest) String() string

func (DeleteRedeemableUserRequest) ValidateEnumValue 

func (request DeleteRedeemableUserRequest) ValidateEnumValue() (bool, error)

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

type DeleteRedeemableUserResponse 

type DeleteRedeemableUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteRedeemableUserResponse wrapper for the DeleteRedeemableUser operation

func (DeleteRedeemableUserResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteRedeemableUserResponse) String 

func (response DeleteRedeemableUserResponse) String() string

type ListProductsProducttypeEnum 

type ListProductsProducttypeEnum string

ListProductsProducttypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListProductsProducttypeEnum

func GetListProductsProducttypeEnumValues 

func GetListProductsProducttypeEnumValues() []ListProductsProducttypeEnum

GetListProductsProducttypeEnumValues Enumerates the set of values for ListProductsProducttypeEnum

func GetMappingListProductsProducttypeEnum 

func GetMappingListProductsProducttypeEnum(val string) (ListProductsProducttypeEnum, bool)

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

type ListProductsRequest 

type ListProductsRequest struct {

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

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

	// The SPM Identifier for the usage period.
	UsagePeriodKey *string `mandatory:"true" contributesTo:"query" name:"usagePeriodKey"`

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

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

	// The maximum number of items to return in the paginated response.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

	// The field to sort by. Supports one sort order.
	SortBy ListProductsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The field to specify the type of product.
	Producttype ListProductsProducttypeEnum `mandatory:"false" contributesTo:"query" name:"producttype" omitEmpty:"true"`

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

ListProductsRequest wrapper for the ListProducts operation

See also

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

func (ListProductsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListProductsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListProductsRequest) RetryPolicy 

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

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

func (ListProductsRequest) String 

func (request ListProductsRequest) String() string

func (ListProductsRequest) ValidateEnumValue 

func (request ListProductsRequest) ValidateEnumValue() (bool, error)

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

type ListProductsResponse 

type ListProductsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListProductsResponse wrapper for the ListProducts operation

func (ListProductsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListProductsResponse) String 

func (response ListProductsResponse) String() string

type ListProductsSortByEnum 

type ListProductsSortByEnum string

ListProductsSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListProductsSortByEnum

func GetListProductsSortByEnumValues 

func GetListProductsSortByEnumValues() []ListProductsSortByEnum

GetListProductsSortByEnumValues Enumerates the set of values for ListProductsSortByEnum

func GetMappingListProductsSortByEnum 

func GetMappingListProductsSortByEnum(val string) (ListProductsSortByEnum, bool)

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

type ListProductsSortOrderEnum 

type ListProductsSortOrderEnum string

ListProductsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListProductsSortOrderEnum

func GetListProductsSortOrderEnumValues 

func GetListProductsSortOrderEnumValues() []ListProductsSortOrderEnum

GetListProductsSortOrderEnumValues Enumerates the set of values for ListProductsSortOrderEnum

func GetMappingListProductsSortOrderEnum 

func GetMappingListProductsSortOrderEnum(val string) (ListProductsSortOrderEnum, bool)

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

type ListRedeemableUsersRequest 

type ListRedeemableUsersRequest struct {

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

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

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

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

	// The maximum number of items to return in the paginated response.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

	// The field to sort by. Supports one sort order.
	SortBy ListRedeemableUsersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

ListRedeemableUsersRequest wrapper for the ListRedeemableUsers operation

See also

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

func (ListRedeemableUsersRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListRedeemableUsersRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListRedeemableUsersRequest) RetryPolicy 

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

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

func (ListRedeemableUsersRequest) String 

func (request ListRedeemableUsersRequest) String() string

func (ListRedeemableUsersRequest) ValidateEnumValue 

func (request ListRedeemableUsersRequest) ValidateEnumValue() (bool, error)

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

type ListRedeemableUsersResponse 

type ListRedeemableUsersResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListRedeemableUsersResponse wrapper for the ListRedeemableUsers operation

func (ListRedeemableUsersResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListRedeemableUsersResponse) String 

func (response ListRedeemableUsersResponse) String() string

type ListRedeemableUsersSortByEnum 

type ListRedeemableUsersSortByEnum string

ListRedeemableUsersSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListRedeemableUsersSortByEnum

func GetListRedeemableUsersSortByEnumValues 

func GetListRedeemableUsersSortByEnumValues() []ListRedeemableUsersSortByEnum

GetListRedeemableUsersSortByEnumValues Enumerates the set of values for ListRedeemableUsersSortByEnum

func GetMappingListRedeemableUsersSortByEnum 

func GetMappingListRedeemableUsersSortByEnum(val string) (ListRedeemableUsersSortByEnum, bool)

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

type ListRedeemableUsersSortOrderEnum 

type ListRedeemableUsersSortOrderEnum string

ListRedeemableUsersSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListRedeemableUsersSortOrderEnum

func GetListRedeemableUsersSortOrderEnumValues 

func GetListRedeemableUsersSortOrderEnumValues() []ListRedeemableUsersSortOrderEnum

GetListRedeemableUsersSortOrderEnumValues Enumerates the set of values for ListRedeemableUsersSortOrderEnum

func GetMappingListRedeemableUsersSortOrderEnum 

func GetMappingListRedeemableUsersSortOrderEnum(val string) (ListRedeemableUsersSortOrderEnum, bool)

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

type ListRedemptionsRequest added in v65.18.0 

type ListRedemptionsRequest struct {

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

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

	// The starting redeemed date filter for the redemption history.
	TimeRedeemedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeRedeemedGreaterThanOrEqualTo"`

	// The ending redeemed date filter for the redemption history.
	TimeRedeemedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeRedeemedLessThan"`

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

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

	// The maximum number of items to return in the paginated response.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

	// The field to be used only for list redemptions API. Supports one sort order.
	SortBy ListRedemptionsSortByEnum `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
}

ListRedemptionsRequest wrapper for the ListRedemptions operation

See also

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

func (ListRedemptionsRequest) BinaryRequestBody added in v65.18.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListRedemptionsRequest) HTTPRequest added in v65.18.0 

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

HTTPRequest implements the OCIRequest interface

func (ListRedemptionsRequest) RetryPolicy added in v65.18.0 

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

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

func (ListRedemptionsRequest) String added in v65.18.0 

func (request ListRedemptionsRequest) String() string

func (ListRedemptionsRequest) ValidateEnumValue added in v65.18.0 

func (request ListRedemptionsRequest) 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 ListRedemptionsResponse added in v65.18.0 

type ListRedemptionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListRedemptionsResponse wrapper for the ListRedemptions operation

func (ListRedemptionsResponse) HTTPResponse added in v65.18.0 

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

HTTPResponse implements the OCIResponse interface

func (ListRedemptionsResponse) String added in v65.18.0 

func (response ListRedemptionsResponse) String() string

type ListRedemptionsSortByEnum added in v65.18.0 

type ListRedemptionsSortByEnum string

ListRedemptionsSortByEnum Enum with underlying type: string 

const (
	ListRedemptionsSortByTimeredeemed ListRedemptionsSortByEnum = "TIMEREDEEMED"
)

Set of constants representing the allowable values for ListRedemptionsSortByEnum

func GetListRedemptionsSortByEnumValues added in v65.18.0 

func GetListRedemptionsSortByEnumValues() []ListRedemptionsSortByEnum

GetListRedemptionsSortByEnumValues Enumerates the set of values for ListRedemptionsSortByEnum

func GetMappingListRedemptionsSortByEnum added in v65.18.0 

func GetMappingListRedemptionsSortByEnum(val string) (ListRedemptionsSortByEnum, bool)

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

type ListRedemptionsSortOrderEnum added in v65.18.0 

type ListRedemptionsSortOrderEnum string

ListRedemptionsSortOrderEnum Enum with underlying type: string 

const (
	ListRedemptionsSortOrderAsc  ListRedemptionsSortOrderEnum = "ASC"
	ListRedemptionsSortOrderDesc ListRedemptionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRedemptionsSortOrderEnum

func GetListRedemptionsSortOrderEnumValues added in v65.18.0 

func GetListRedemptionsSortOrderEnumValues() []ListRedemptionsSortOrderEnum

GetListRedemptionsSortOrderEnumValues Enumerates the set of values for ListRedemptionsSortOrderEnum

func GetMappingListRedemptionsSortOrderEnum added in v65.18.0 

func GetMappingListRedemptionsSortOrderEnum(val string) (ListRedemptionsSortOrderEnum, bool)

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

type ListResourceQuotaRequest added in v65.41.0 

type ListResourceQuotaRequest struct {

	// Service Name.
	ServiceName *string `mandatory:"true" contributesTo:"query" name:"serviceName"`

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

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

	// Service entitlement Id.
	ServiceEntitlement *string `mandatory:"false" contributesTo:"query" name:"serviceEntitlement"`

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

	// The maximum number of items to return in the paginated response.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

	// The field to sort by. Supports one sort order.
	SortBy ListResourceQuotaSortByEnum `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
}

ListResourceQuotaRequest wrapper for the ListResourceQuota operation

See also

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

func (ListResourceQuotaRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListResourceQuotaRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (ListResourceQuotaRequest) RetryPolicy added in v65.41.0 

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

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

func (ListResourceQuotaRequest) String added in v65.41.0 

func (request ListResourceQuotaRequest) String() string

func (ListResourceQuotaRequest) ValidateEnumValue added in v65.41.0 

func (request ListResourceQuotaRequest) 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 ListResourceQuotaResponse added in v65.41.0 

type ListResourceQuotaResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ResourceQuotumCollection instances
	ResourceQuotumCollection `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"`
}

ListResourceQuotaResponse wrapper for the ListResourceQuota operation

func (ListResourceQuotaResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (ListResourceQuotaResponse) String added in v65.41.0 

func (response ListResourceQuotaResponse) String() string

type ListResourceQuotaSortByEnum added in v65.41.0 

type ListResourceQuotaSortByEnum string

ListResourceQuotaSortByEnum Enum with underlying type: string 

const (
	ListResourceQuotaSortByTimecreated ListResourceQuotaSortByEnum = "TIMECREATED"
	ListResourceQuotaSortByTimestart   ListResourceQuotaSortByEnum = "TIMESTART"
)

Set of constants representing the allowable values for ListResourceQuotaSortByEnum

func GetListResourceQuotaSortByEnumValues added in v65.41.0 

func GetListResourceQuotaSortByEnumValues() []ListResourceQuotaSortByEnum

GetListResourceQuotaSortByEnumValues Enumerates the set of values for ListResourceQuotaSortByEnum

func GetMappingListResourceQuotaSortByEnum added in v65.41.0 

func GetMappingListResourceQuotaSortByEnum(val string) (ListResourceQuotaSortByEnum, bool)

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

type ListResourceQuotaSortOrderEnum added in v65.41.0 

type ListResourceQuotaSortOrderEnum string

ListResourceQuotaSortOrderEnum Enum with underlying type: string 

const (
	ListResourceQuotaSortOrderAsc  ListResourceQuotaSortOrderEnum = "ASC"
	ListResourceQuotaSortOrderDesc ListResourceQuotaSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListResourceQuotaSortOrderEnum

func GetListResourceQuotaSortOrderEnumValues added in v65.41.0 

func GetListResourceQuotaSortOrderEnumValues() []ListResourceQuotaSortOrderEnum

GetListResourceQuotaSortOrderEnumValues Enumerates the set of values for ListResourceQuotaSortOrderEnum

func GetMappingListResourceQuotaSortOrderEnum added in v65.41.0 

func GetMappingListResourceQuotaSortOrderEnum(val string) (ListResourceQuotaSortOrderEnum, bool)

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

type ListResourcesRequest added in v65.41.0 

type ListResourcesRequest struct {

	// Service Name.
	ServiceName *string `mandatory:"true" contributesTo:"query" name:"serviceName"`

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

	// Subscription or entitlement Id.
	EntitlementId *string `mandatory:"false" contributesTo:"query" name:"entitlementId"`

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

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

	// The maximum number of items to return in the paginated response.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

	// The field to sort by. Supports one sort order.
	SortBy ListResourcesSortByEnum `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
}

ListResourcesRequest wrapper for the ListResources operation

See also

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

func (ListResourcesRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListResourcesRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (ListResourcesRequest) RetryPolicy added in v65.41.0 

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

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

func (ListResourcesRequest) String added in v65.41.0 

func (request ListResourcesRequest) String() string

func (ListResourcesRequest) ValidateEnumValue added in v65.41.0 

func (request ListResourcesRequest) 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 ListResourcesResponse added in v65.41.0 

type ListResourcesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ResourcesCollection instances
	ResourcesCollection `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"`
}

ListResourcesResponse wrapper for the ListResources operation

func (ListResourcesResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (ListResourcesResponse) String added in v65.41.0 

func (response ListResourcesResponse) String() string

type ListResourcesSortByEnum added in v65.41.0 

type ListResourcesSortByEnum string

ListResourcesSortByEnum Enum with underlying type: string 

const (
	ListResourcesSortByTimecreated ListResourcesSortByEnum = "TIMECREATED"
	ListResourcesSortByTimestart   ListResourcesSortByEnum = "TIMESTART"
)

Set of constants representing the allowable values for ListResourcesSortByEnum

func GetListResourcesSortByEnumValues added in v65.41.0 

func GetListResourcesSortByEnumValues() []ListResourcesSortByEnum

GetListResourcesSortByEnumValues Enumerates the set of values for ListResourcesSortByEnum

func GetMappingListResourcesSortByEnum added in v65.41.0 

func GetMappingListResourcesSortByEnum(val string) (ListResourcesSortByEnum, bool)

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

type ListResourcesSortOrderEnum added in v65.41.0 

type ListResourcesSortOrderEnum string

ListResourcesSortOrderEnum Enum with underlying type: string 

const (
	ListResourcesSortOrderAsc  ListResourcesSortOrderEnum = "ASC"
	ListResourcesSortOrderDesc ListResourcesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListResourcesSortOrderEnum

func GetListResourcesSortOrderEnumValues added in v65.41.0 

func GetListResourcesSortOrderEnumValues() []ListResourcesSortOrderEnum

GetListResourcesSortOrderEnumValues Enumerates the set of values for ListResourcesSortOrderEnum

func GetMappingListResourcesSortOrderEnum added in v65.41.0 

func GetMappingListResourcesSortOrderEnum(val string) (ListResourcesSortOrderEnum, bool)

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

type ListRewardsRequest 

type ListRewardsRequest struct {

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

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

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

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

ListRewardsRequest wrapper for the ListRewards operation

See also

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

func (ListRewardsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListRewardsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListRewardsRequest) RetryPolicy 

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

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

func (ListRewardsRequest) String 

func (request ListRewardsRequest) String() string

func (ListRewardsRequest) ValidateEnumValue 

func (request ListRewardsRequest) ValidateEnumValue() (bool, error)

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

type ListRewardsResponse 

type ListRewardsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ListRewardsResponse wrapper for the ListRewards operation

func (ListRewardsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListRewardsResponse) String 

func (response ListRewardsResponse) String() string

type ListUsageLimitsRequest added in v65.41.0 

type ListUsageLimitsRequest struct {

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

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

	// Hard or soft limit. Hard limits lead to breaches, soft to alerts.
	LimitType *string `mandatory:"false" contributesTo:"query" name:"limitType"`

	// Resource Name.
	ResourceType *string `mandatory:"false" contributesTo:"query" name:"resourceType"`

	// Service Name.
	ServiceType *string `mandatory:"false" contributesTo:"query" name:"serviceType"`

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

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

	// The maximum number of items to return in the paginated response.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

	// The field to sort by. Supports one sort order.
	SortBy ListUsageLimitsSortByEnum `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
}

ListUsageLimitsRequest wrapper for the ListUsageLimits operation

See also

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

func (ListUsageLimitsRequest) BinaryRequestBody added in v65.41.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListUsageLimitsRequest) HTTPRequest added in v65.41.0 

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

HTTPRequest implements the OCIRequest interface

func (ListUsageLimitsRequest) RetryPolicy added in v65.41.0 

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

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

func (ListUsageLimitsRequest) String added in v65.41.0 

func (request ListUsageLimitsRequest) String() string

func (ListUsageLimitsRequest) ValidateEnumValue added in v65.41.0 

func (request ListUsageLimitsRequest) 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 ListUsageLimitsResponse added in v65.41.0 

type ListUsageLimitsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListUsageLimitsResponse wrapper for the ListUsageLimits operation

func (ListUsageLimitsResponse) HTTPResponse added in v65.41.0 

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

HTTPResponse implements the OCIResponse interface

func (ListUsageLimitsResponse) String added in v65.41.0 

func (response ListUsageLimitsResponse) String() string

type ListUsageLimitsSortByEnum added in v65.41.0 

type ListUsageLimitsSortByEnum string

ListUsageLimitsSortByEnum Enum with underlying type: string 

const (
	ListUsageLimitsSortByTimecreated ListUsageLimitsSortByEnum = "TIMECREATED"
	ListUsageLimitsSortByTimestart   ListUsageLimitsSortByEnum = "TIMESTART"
)

Set of constants representing the allowable values for ListUsageLimitsSortByEnum

func GetListUsageLimitsSortByEnumValues added in v65.41.0 

func GetListUsageLimitsSortByEnumValues() []ListUsageLimitsSortByEnum

GetListUsageLimitsSortByEnumValues Enumerates the set of values for ListUsageLimitsSortByEnum

func GetMappingListUsageLimitsSortByEnum added in v65.41.0 

func GetMappingListUsageLimitsSortByEnum(val string) (ListUsageLimitsSortByEnum, bool)

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

type ListUsageLimitsSortOrderEnum added in v65.41.0 

type ListUsageLimitsSortOrderEnum string

ListUsageLimitsSortOrderEnum Enum with underlying type: string 

const (
	ListUsageLimitsSortOrderAsc  ListUsageLimitsSortOrderEnum = "ASC"
	ListUsageLimitsSortOrderDesc ListUsageLimitsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListUsageLimitsSortOrderEnum

func GetListUsageLimitsSortOrderEnumValues added in v65.41.0 

func GetListUsageLimitsSortOrderEnumValues() []ListUsageLimitsSortOrderEnum

GetListUsageLimitsSortOrderEnumValues Enumerates the set of values for ListUsageLimitsSortOrderEnum

func GetMappingListUsageLimitsSortOrderEnum added in v65.41.0 

func GetMappingListUsageLimitsSortOrderEnum(val string) (ListUsageLimitsSortOrderEnum, bool)

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

type MonthlyRewardSummary 

type MonthlyRewardSummary struct {

	// The number of rewards available for a specific usage period.
	AvailableRewards *float32 `mandatory:"false" json:"availableRewards"`

	// The number of rewards redeemed for a specific month.
	RedeemedRewards *float32 `mandatory:"false" json:"redeemedRewards"`

	// The number of rewards earned for the specific usage period.
	EarnedRewards *float32 `mandatory:"false" json:"earnedRewards"`

	// The boolean parameter to indicate whether or not the available rewards are manually posted.
	IsManual *bool `mandatory:"false" json:"isManual"`

	// The date and time when rewards expire.
	TimeRewardsExpired *common.SDKTime `mandatory:"false" json:"timeRewardsExpired"`

	// The date and time when rewards accrue.
	TimeRewardsEarned *common.SDKTime `mandatory:"false" json:"timeRewardsEarned"`

	// The start date and time for the usage period.
	TimeUsageStarted *common.SDKTime `mandatory:"false" json:"timeUsageStarted"`

	// The end date and time for the usage period.
	TimeUsageEnded *common.SDKTime `mandatory:"false" json:"timeUsageEnded"`

	// The usage amount for the usage period.
	UsageAmount *float64 `mandatory:"false" json:"usageAmount"`

	// The eligible usage amount for the usage period.
	EligibleUsageAmount *float64 `mandatory:"false" json:"eligibleUsageAmount"`

	// The ineligible usage amount for the usage period.
	IneligibleUsageAmount *float64 `mandatory:"false" json:"ineligibleUsageAmount"`

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

MonthlyRewardSummary Object describing the monthly rewards summary for the requested subscription ID.

func (MonthlyRewardSummary) String 

func (m MonthlyRewardSummary) String() string

func (MonthlyRewardSummary) ValidateEnumValue 

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

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

type ProductCollection 

type ProductCollection struct {

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

ProductCollection A product list.

func (ProductCollection) String 

func (m ProductCollection) String() string

func (ProductCollection) ValidateEnumValue 

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

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

type ProductSummary 

type ProductSummary struct {

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

	// The rate card product name.
	ProductName *string `mandatory:"false" json:"productName"`

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

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

	// The boolean parameter to indicate if the product is eligible to earn rewards.
	IsEligibleToEarnRewards *bool `mandatory:"false" json:"isEligibleToEarnRewards"`
}

ProductSummary Provides details about product rewards and the usage amount.

func (ProductSummary) String 

func (m ProductSummary) String() string

func (ProductSummary) ValidateEnumValue 

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

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

type RedeemableUser 

type RedeemableUser struct {

	// The email ID for a user that can redeem rewards.
	EmailId *string `mandatory:"true" json:"emailId"`

	// The first name of the user that can redeem rewards.
	FirstName *string `mandatory:"false" json:"firstName"`

	// The last name of the user that can redeem rewards.
	LastName *string `mandatory:"false" json:"lastName"`
}

RedeemableUser The summary of a user that can redeem rewards.

func (RedeemableUser) String 

func (m RedeemableUser) String() string

func (RedeemableUser) ValidateEnumValue 

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

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

type RedeemableUserCollection 

type RedeemableUserCollection struct {

	// The list of user summary that can redeem rewards.
	Items []RedeemableUserSummary `mandatory:"true" json:"items"`
}

RedeemableUserCollection The list of user summary that can redeem rewards.

func (RedeemableUserCollection) String 

func (m RedeemableUserCollection) String() string

func (RedeemableUserCollection) ValidateEnumValue 

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

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

type RedeemableUserSummary 

type RedeemableUserSummary struct {

	// The email ID of the user that can redeem rewards.
	EmailId *string `mandatory:"false" json:"emailId"`

	// The first name of the user that can redeem rewards.
	FirstName *string `mandatory:"false" json:"firstName"`

	// The last name of the user that can redeem rewards.
	LastName *string `mandatory:"false" json:"lastName"`
}

RedeemableUserSummary User summary that can redeem rewards.

func (RedeemableUserSummary) String 

func (m RedeemableUserSummary) String() string

func (RedeemableUserSummary) ValidateEnumValue 

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

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

type RedemptionCollection added in v65.18.0 

type RedemptionCollection struct {

	// The list of redemption summary.
	Items []RedemptionSummary `mandatory:"true" json:"items"`
}

RedemptionCollection The list of redemption summary for the requested subscription ID and date range.

func (RedemptionCollection) String added in v65.18.0 

func (m RedemptionCollection) String() string

func (RedemptionCollection) ValidateEnumValue added in v65.18.0 

func (m RedemptionCollection) 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 RedemptionSummary added in v65.18.0 

type RedemptionSummary struct {

	// It provides redeem date.
	TimeRedeemed *common.SDKTime `mandatory:"false" json:"timeRedeemed"`

	// It provides the redemption email id.
	RedemptionEmail *string `mandatory:"false" json:"redemptionEmail"`

	// The redemption code used in the Billing Center during the reward redemption process.
	RedemptionCode *string `mandatory:"false" json:"redemptionCode"`

	// It provides the invoice number against the redemption.
	InvoiceNumber *string `mandatory:"false" json:"invoiceNumber"`

	// It provides the invoice total amount of given redemption.
	InvoiceTotalAmount *float64 `mandatory:"false" json:"invoiceTotalAmount"`

	// The currency associated with invoice.
	InvoiceCurrency *string `mandatory:"false" json:"invoiceCurrency"`

	// It provides the redeemed rewards in invoice currency.
	RedeemedRewards *float32 `mandatory:"false" json:"redeemedRewards"`

	// It provides the redeemed rewards in base/subscription currency.
	BaseRewards *float32 `mandatory:"false" json:"baseRewards"`

	// It provides the fxRate between invoice currency and subscription currency.
	FxRate *float64 `mandatory:"false" json:"fxRate"`

	// It provides the invoice date.
	TimeInvoiced *common.SDKTime `mandatory:"false" json:"timeInvoiced"`
}

RedemptionSummary The redemption summary for the requested subscription ID and date range.

func (RedemptionSummary) String added in v65.18.0 

func (m RedemptionSummary) String() string

func (RedemptionSummary) ValidateEnumValue added in v65.18.0 

func (m RedemptionSummary) 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 ResourceQuotumCollection added in v65.41.0 

type ResourceQuotumCollection struct {

	// The list of resource quota details.
	Items []ResourceQuotumSummary `mandatory:"true" json:"items"`

	// Used to indicate if further quota consumption isAllowed.
	IsAllowed *bool `mandatory:"true" json:"isAllowed"`
}

ResourceQuotumCollection The quota details of resources under a tenancy.

func (ResourceQuotumCollection) String added in v65.41.0 

func (m ResourceQuotumCollection) String() string

func (ResourceQuotumCollection) ValidateEnumValue added in v65.41.0 

func (m ResourceQuotumCollection) 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 ResourceQuotumSummary added in v65.41.0 

type ResourceQuotumSummary struct {

	// The resource name.
	Name *string `mandatory:"false" json:"name"`

	// Used to indicate if further quota consumption isAllowed.
	IsAllowed *bool `mandatory:"false" json:"isAllowed"`

	// The quota limit.
	Limit *float64 `mandatory:"false" json:"limit"`

	// The quota balance.
	Balance *float64 `mandatory:"false" json:"balance"`

	// Used to indicate if overages are incurred.
	IsOverage *bool `mandatory:"false" json:"isOverage"`

	// The purchased quota limit.
	PurchasedLimit *float64 `mandatory:"false" json:"purchasedLimit"`

	// The service name.
	Service *string `mandatory:"false" json:"service"`

	// Used to indicate any resource dependencies.
	IsDependency *bool `mandatory:"false" json:"isDependency"`

	// The affected resource name.
	AffectedResource *string `mandatory:"false" json:"affectedResource"`
}

ResourceQuotumSummary The resource quota balance details.

func (ResourceQuotumSummary) String added in v65.41.0 

func (m ResourceQuotumSummary) String() string

func (ResourceQuotumSummary) ValidateEnumValue added in v65.41.0 

func (m ResourceQuotumSummary) 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 ResourceSummary added in v65.41.0 

type ResourceSummary struct {

	// Units to be used for daily aggregated data.
	DailyUnitDisplayName *string `mandatory:"false" json:"dailyUnitDisplayName"`

	// Units to be used for hourly aggregated data.
	HourlyUnitDisplayName *string `mandatory:"false" json:"hourlyUnitDisplayName"`

	// Default units to use when unspecified.
	RawUnitDisplayName *string `mandatory:"false" json:"rawUnitDisplayName"`

	// Usage data type of the resource.
	UsageDataType ResourceSummaryUsageDataTypeEnum `mandatory:"false" json:"usageDataType,omitempty"`

	// Name of the resource.
	Name *string `mandatory:"false" json:"name"`

	// Name of the service.
	Servicename *string `mandatory:"false" json:"servicename"`

	// Description of the resource.
	Description *string `mandatory:"false" json:"description"`

	// Instance type for the resource.
	InstanceType *string `mandatory:"false" json:"instanceType"`

	// Indicates if the SKU was purchased
	IsPurchased *bool `mandatory:"false" json:"isPurchased"`

	// The details of any child resources.
	ChildResources []string `mandatory:"false" json:"childResources"`

	// The details of resource Skus.
	Skus []SkuProducts `mandatory:"false" json:"skus"`
}

ResourceSummary The details of a resource under a service.

func (ResourceSummary) String added in v65.41.0 

func (m ResourceSummary) String() string

func (ResourceSummary) ValidateEnumValue added in v65.41.0 

func (m ResourceSummary) 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 ResourceSummaryUsageDataTypeEnum added in v65.41.0 

type ResourceSummaryUsageDataTypeEnum string

ResourceSummaryUsageDataTypeEnum Enum with underlying type: string 

const (
	ResourceSummaryUsageDataTypeInterval  ResourceSummaryUsageDataTypeEnum = "INTERVAL"
	ResourceSummaryUsageDataTypePointData ResourceSummaryUsageDataTypeEnum = "POINT_DATA"
)

Set of constants representing the allowable values for ResourceSummaryUsageDataTypeEnum

func GetMappingResourceSummaryUsageDataTypeEnum added in v65.41.0 

func GetMappingResourceSummaryUsageDataTypeEnum(val string) (ResourceSummaryUsageDataTypeEnum, bool)

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

func GetResourceSummaryUsageDataTypeEnumValues added in v65.41.0 

func GetResourceSummaryUsageDataTypeEnumValues() []ResourceSummaryUsageDataTypeEnum

GetResourceSummaryUsageDataTypeEnumValues Enumerates the set of values for ResourceSummaryUsageDataTypeEnum

type ResourcesClient added in v65.41.0 

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

ResourcesClient a client for Resources

func NewResourcesClientWithConfigurationProvider added in v65.41.0 

func NewResourcesClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ResourcesClient, err error)

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

func NewResourcesClientWithOboToken added in v65.41.0 

func NewResourcesClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ResourcesClient, err error)

NewResourcesClientWithOboToken Creates a new default Resources 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 (*ResourcesClient) ConfigurationProvider added in v65.41.0 

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

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

func (ResourcesClient) ListResourceQuota added in v65.41.0 

func (client ResourcesClient) ListResourceQuota(ctx context.Context, request ListResourceQuotaRequest) (response ListResourceQuotaResponse, err error)

ListResourceQuota Returns the resource quota details under a tenancy > **Important**: Calls to this API will only succeed against the endpoint in the home region.

See also

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

func (ResourcesClient) ListResources added in v65.41.0 

func (client ResourcesClient) ListResources(ctx context.Context, request ListResourcesRequest) (response ListResourcesResponse, err error)

ListResources Returns the resource details for a service > **Important**: Calls to this API will only succeed against the endpoint in the home region.

See also

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

func (*ResourcesClient) SetRegion added in v65.41.0 

func (client *ResourcesClient) SetRegion(region string)

SetRegion overrides the region of this client.

type ResourcesCollection added in v65.41.0 

type ResourcesCollection struct {

	// The list of resource details for a service.
	Items []ResourceSummary `mandatory:"true" json:"items"`
}

ResourcesCollection The resources of a service.

func (ResourcesCollection) String added in v65.41.0 

func (m ResourcesCollection) String() string

func (ResourcesCollection) ValidateEnumValue added in v65.41.0 

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

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

type RewardCollection 

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

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

RewardCollection The response object for the ListRewards API call. Provides information about the subscription rewards.

func (RewardCollection) String 

func (m RewardCollection) String() string

func (RewardCollection) ValidateEnumValue 

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

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

type RewardDetails 

type RewardDetails struct {

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

	// The entitlement ID from MQS, which is the same as the subcription ID.
	SubscriptionId *string `mandatory:"false" json:"subscriptionId"`

	// The currency unit for the reward amount.
	Currency *string `mandatory:"false" json:"currency"`

	// The current Rewards percentage in decimal format.
	RewardsRate *float64 `mandatory:"false" json:"rewardsRate"`

	// The total number of available rewards for a given subscription ID.
	TotalRewardsAvailable *float32 `mandatory:"false" json:"totalRewardsAvailable"`

	// The redemption code used in the Billing Center during the reward redemption process.
	RedemptionCode *string `mandatory:"false" json:"redemptionCode"`
}

RewardDetails The overall monthly reward summary.

func (RewardDetails) String 

func (m RewardDetails) String() string

func (RewardDetails) ValidateEnumValue 

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

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

type RewardsClient 

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

RewardsClient a client for Rewards

func NewRewardsClientWithConfigurationProvider 

func NewRewardsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RewardsClient, err error)

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

func NewRewardsClientWithOboToken 

func NewRewardsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RewardsClient, err error)

NewRewardsClientWithOboToken Creates a new default Rewards client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer 

as well as reading the region

func (*RewardsClient) ConfigurationProvider 

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

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

func (RewardsClient) CreateRedeemableUser 

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

CreateRedeemableUser Adds the list of redeemable user summary for a subscription ID.

See also

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

func (RewardsClient) DeleteRedeemableUser 

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

DeleteRedeemableUser Deletes the list of redeemable user email ID for a subscription ID.

See also

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

func (RewardsClient) ListProducts 

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

ListProducts Provides product information that is specific to a reward usage period and its usage details.

See also

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

func (RewardsClient) ListRedeemableUsers 

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

ListRedeemableUsers Provides the list of user summary that can redeem rewards for the given subscription ID.

See also

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

func (RewardsClient) ListRedemptions added in v65.18.0 

func (client RewardsClient) ListRedemptions(ctx context.Context, request ListRedemptionsRequest) (response ListRedemptionsResponse, err error)

ListRedemptions Returns the list of redemption for the subscription ID.

See also

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

func (RewardsClient) ListRewards 

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

ListRewards Returns the list of rewards for a subscription ID.

See also

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

func (*RewardsClient) SetRegion 

func (client *RewardsClient) SetRegion(region string)

SetRegion overrides the region of this client.

type SkuProducts added in v65.41.0 

type SkuProducts struct {

	// The Sku Id for the resource.
	SkuId *string `mandatory:"false" json:"skuId"`

	// The Sku type for the resource.
	SkuType *string `mandatory:"false" json:"skuType"`

	// The cloud credit type for the resource.
	CloudCreditType *string `mandatory:"false" json:"cloudCreditType"`
}

SkuProducts The SKU Product Id details for a resource.

func (SkuProducts) String added in v65.41.0 

func (m SkuProducts) String() string

func (SkuProducts) ValidateEnumValue added in v65.41.0 

func (m SkuProducts) 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 UsageLimitCollection added in v65.41.0 

type UsageLimitCollection struct {

	// The list of usage limits.
	Items []UsageLimitSummary `mandatory:"true" json:"items"`
}

UsageLimitCollection The list of usage limit summary for the requested tenancy ID and subscription ID.

func (UsageLimitCollection) String added in v65.41.0 

func (m UsageLimitCollection) String() string

func (UsageLimitCollection) ValidateEnumValue added in v65.41.0 

func (m UsageLimitCollection) 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 UsageLimitSummary added in v65.41.0 

type UsageLimitSummary struct {

	// Time when the usage limit was created
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Entitlement ID of the usage limit
	EntitlementId *string `mandatory:"true" json:"entitlementId"`

	// The usage limit ID
	Id *string `mandatory:"true" json:"id"`

	// Time when the usage limit was modified
	TimeModified *common.SDKTime `mandatory:"true" json:"timeModified"`

	// The resource for which the limit is defined
	ResourceName *string `mandatory:"true" json:"resourceName"`

	// The service for which the limit is defined
	ServiceName *string `mandatory:"true" json:"serviceName"`

	// The limit value
	Limit *string `mandatory:"true" json:"limit"`

	// The user who created the limit
	CreatedBy *string `mandatory:"true" json:"createdBy"`

	// The user who modified the limit
	ModifiedBy *string `mandatory:"true" json:"modifiedBy"`

	// The action when usage limit is hit
	Action UsageLimitSummaryActionEnum `mandatory:"true" json:"action"`

	// The alert level of the usage limit
	AlertLevel *float32 `mandatory:"true" json:"alertLevel"`

	// The limit type of the usage limit
	LimitType UsageLimitSummaryLimitTypeEnum `mandatory:"true" json:"limitType"`

	// The value type of the usage limit
	ValueType UsageLimitSummaryValueTypeEnum `mandatory:"true" json:"valueType"`

	// The usage limit lifecycle state.
	LifecycleState UsageLimitSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The maximum hard limit set for the usage limit
	MaxHardLimit *string `mandatory:"false" json:"maxHardLimit"`

	// The SKU for which the usage limit is set
	SkuPartId *string `mandatory:"false" json:"skuPartId"`
}

UsageLimitSummary Encapsulates a collection of Hard and Soft Limits for a resource within a subscription.

func (UsageLimitSummary) String added in v65.41.0 

func (m UsageLimitSummary) String() string

func (UsageLimitSummary) ValidateEnumValue added in v65.41.0 

func (m UsageLimitSummary) 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 UsageLimitSummaryActionEnum added in v65.41.0 

type UsageLimitSummaryActionEnum string

UsageLimitSummaryActionEnum Enum with underlying type: string 

const (
	UsageLimitSummaryActionBreach UsageLimitSummaryActionEnum = "QUOTA_BREACH"
	UsageLimitSummaryActionAlert  UsageLimitSummaryActionEnum = "QUOTA_ALERT"
)

Set of constants representing the allowable values for UsageLimitSummaryActionEnum

func GetMappingUsageLimitSummaryActionEnum added in v65.41.0 

func GetMappingUsageLimitSummaryActionEnum(val string) (UsageLimitSummaryActionEnum, bool)

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

func GetUsageLimitSummaryActionEnumValues added in v65.41.0 

func GetUsageLimitSummaryActionEnumValues() []UsageLimitSummaryActionEnum

GetUsageLimitSummaryActionEnumValues Enumerates the set of values for UsageLimitSummaryActionEnum

type UsageLimitSummaryLifecycleStateEnum added in v65.41.0 

type UsageLimitSummaryLifecycleStateEnum string

UsageLimitSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	UsageLimitSummaryLifecycleStateActive UsageLimitSummaryLifecycleStateEnum = "ACTIVE"
)

Set of constants representing the allowable values for UsageLimitSummaryLifecycleStateEnum

func GetMappingUsageLimitSummaryLifecycleStateEnum added in v65.41.0 

func GetMappingUsageLimitSummaryLifecycleStateEnum(val string) (UsageLimitSummaryLifecycleStateEnum, bool)

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

func GetUsageLimitSummaryLifecycleStateEnumValues added in v65.41.0 

func GetUsageLimitSummaryLifecycleStateEnumValues() []UsageLimitSummaryLifecycleStateEnum

GetUsageLimitSummaryLifecycleStateEnumValues Enumerates the set of values for UsageLimitSummaryLifecycleStateEnum

type UsageLimitSummaryLimitTypeEnum added in v65.41.0 

type UsageLimitSummaryLimitTypeEnum string

UsageLimitSummaryLimitTypeEnum Enum with underlying type: string 

const (
	UsageLimitSummaryLimitTypeHard UsageLimitSummaryLimitTypeEnum = "HARD"
	UsageLimitSummaryLimitTypeSoft UsageLimitSummaryLimitTypeEnum = "SOFT"
)

Set of constants representing the allowable values for UsageLimitSummaryLimitTypeEnum

func GetMappingUsageLimitSummaryLimitTypeEnum added in v65.41.0 

func GetMappingUsageLimitSummaryLimitTypeEnum(val string) (UsageLimitSummaryLimitTypeEnum, bool)

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

func GetUsageLimitSummaryLimitTypeEnumValues added in v65.41.0 

func GetUsageLimitSummaryLimitTypeEnumValues() []UsageLimitSummaryLimitTypeEnum

GetUsageLimitSummaryLimitTypeEnumValues Enumerates the set of values for UsageLimitSummaryLimitTypeEnum

type UsageLimitSummaryValueTypeEnum added in v65.41.0 

type UsageLimitSummaryValueTypeEnum string

UsageLimitSummaryValueTypeEnum Enum with underlying type: string 

const (
	UsageLimitSummaryValueTypeAbsolute   UsageLimitSummaryValueTypeEnum = "ABSOLUTE"
	UsageLimitSummaryValueTypePercentage UsageLimitSummaryValueTypeEnum = "PERCENTAGE"
)

Set of constants representing the allowable values for UsageLimitSummaryValueTypeEnum

func GetMappingUsageLimitSummaryValueTypeEnum added in v65.41.0 

func GetMappingUsageLimitSummaryValueTypeEnum(val string) (UsageLimitSummaryValueTypeEnum, bool)

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

func GetUsageLimitSummaryValueTypeEnumValues added in v65.41.0 

func GetUsageLimitSummaryValueTypeEnumValues() []UsageLimitSummaryValueTypeEnum

GetUsageLimitSummaryValueTypeEnumValues Enumerates the set of values for UsageLimitSummaryValueTypeEnum

type UsagelimitsClient added in v65.41.0 

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

UsagelimitsClient a client for Usagelimits

func NewUsagelimitsClientWithConfigurationProvider added in v65.41.0 

func NewUsagelimitsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client UsagelimitsClient, err error)

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

func NewUsagelimitsClientWithOboToken added in v65.41.0 

func NewUsagelimitsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client UsagelimitsClient, err error)

NewUsagelimitsClientWithOboToken Creates a new default Usagelimits 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 (*UsagelimitsClient) ConfigurationProvider added in v65.41.0 

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

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

func (UsagelimitsClient) ListUsageLimits added in v65.41.0 

func (client UsagelimitsClient) ListUsageLimits(ctx context.Context, request ListUsageLimitsRequest) (response ListUsageLimitsResponse, err error)

ListUsageLimits Returns the list of usage limit for the subscription ID and tenant ID.

See also

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

func (*UsagelimitsClient) SetRegion added in v65.41.0 

func (client *UsagelimitsClient) SetRegion(region string)

SetRegion overrides the region of this client.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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