com.oracle.bmc.usage

Interface RewardsAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RewardsAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public interface RewardsAsync
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.

Method Summary

Modifier and Type	Method and Description
Future<CreateRedeemableUserResponse>	createRedeemableUser(CreateRedeemableUserRequest request, AsyncHandler<CreateRedeemableUserRequest,CreateRedeemableUserResponse> handler) Adds the list of redeemable user summary for a subscription ID.
Future<DeleteRedeemableUserResponse>	deleteRedeemableUser(DeleteRedeemableUserRequest request, AsyncHandler<DeleteRedeemableUserRequest,DeleteRedeemableUserResponse> handler) 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)
Future<ListProductsResponse>	listProducts(ListProductsRequest request, AsyncHandler<ListProductsRequest,ListProductsResponse> handler) Provides product information that is specific to a reward usage period and its usage details.
Future<ListRedeemableUsersResponse>	listRedeemableUsers(ListRedeemableUsersRequest request, AsyncHandler<ListRedeemableUsersRequest,ListRedeemableUsersResponse> handler) Provides the list of user summary that can redeem rewards for the given subscription ID.
Future<ListRedemptionsResponse>	listRedemptions(ListRedemptionsRequest request, AsyncHandler<ListRedemptionsRequest,ListRedemptionsResponse> handler) Returns the list of redemption for the subscription ID.
Future<ListRewardsResponse>	listRewards(ListRewardsRequest request, AsyncHandler<ListRewardsRequest,ListRewardsResponse> handler) 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 serice.

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

Future<CreateRedeemableUserResponse> createRedeemableUser(CreateRedeemableUserRequest request,
                                                          AsyncHandler<CreateRedeemableUserRequest,CreateRedeemableUserResponse> handler)

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

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteRedeemableUser

Future<DeleteRedeemableUserResponse> deleteRedeemableUser(DeleteRedeemableUserRequest request,
                                                          AsyncHandler<DeleteRedeemableUserRequest,DeleteRedeemableUserResponse> handler)

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

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listProducts

Future<ListProductsResponse> listProducts(ListProductsRequest request,
                                          AsyncHandler<ListProductsRequest,ListProductsResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listRedeemableUsers

Future<ListRedeemableUsersResponse> listRedeemableUsers(ListRedeemableUsersRequest request,
                                                        AsyncHandler<ListRedeemableUsersRequest,ListRedeemableUsersResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listRedemptions

Future<ListRedemptionsResponse> listRedemptions(ListRedemptionsRequest request,
                                                AsyncHandler<ListRedemptionsRequest,ListRedemptionsResponse> handler)

Returns the list of redemption for the subscription ID.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listRewards

Future<ListRewardsResponse> listRewards(ListRewardsRequest request,
                                        AsyncHandler<ListRewardsRequest,ListRewardsResponse> handler)

Returns the list of rewards for a subscription ID.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.