com.oracle.bmc.usage

Interface Rewards

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RewardsClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public interface Rewards
extends AutoCloseable

Use the Usage Proxy API to list Oracle Support Rewards, view related detailed usage information, and manage users who redeem rewards. For more information, see Oracle Support Rewards Overview. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
CreateRedeemableUserResponse	createRedeemableUser(CreateRedeemableUserRequest request) Adds the list of redeemable user summary for a subscription ID.
DeleteRedeemableUserResponse	deleteRedeemableUser(DeleteRedeemableUserRequest request) Deletes the list of redeemable user email ID for a subscription ID.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
RewardsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListProductsResponse	listProducts(ListProductsRequest request) Provides product information that is specific to a reward usage period and its usage details.
ListRedeemableUsersResponse	listRedeemableUsers(ListRedeemableUsersRequest request) Provides the list of user summary that can redeem rewards for the given subscription ID.
ListRedemptionsResponse	listRedemptions(ListRedemptionsRequest request) Returns the list of redemption for the subscription ID.
ListRewardsResponse	listRewards(ListRewardsRequest request) Returns the list of rewards for a subscription ID.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

createRedeemableUser

CreateRedeemableUserResponse createRedeemableUser(CreateRedeemableUserRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateRedeemableUser API.

deleteRedeemableUser

DeleteRedeemableUserResponse deleteRedeemableUser(DeleteRedeemableUserRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteRedeemableUser API.

listProducts

ListProductsResponse listProducts(ListProductsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListProducts API.

listRedeemableUsers

ListRedeemableUsersResponse listRedeemableUsers(ListRedeemableUsersRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListRedeemableUsers API.

listRedemptions

ListRedemptionsResponse listRedemptions(ListRedemptionsRequest request)

Returns the list of redemption for the subscription ID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListRedemptions API.

listRewards

ListRewardsResponse listRewards(ListRewardsRequest request)

Returns the list of rewards for a subscription ID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListRewards API.

getPaginators

RewardsPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.