Package com.oracle.bmc.usage

Class RewardsClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.usage.RewardsClient

All Implemented Interfaces:

Rewards, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public class RewardsClient
extends BaseSyncClient
implements Rewards

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RewardsClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for Rewards.

Constructor Summary

Constructors

Constructor	Description
RewardsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
RewardsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
RewardsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
RewardsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
RewardsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
RewardsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
RewardsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static RewardsClient.Builder	builder()	Create a builder for this client.
void	close()
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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.usage.Rewards

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Rewards.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

RewardsClient

@Deprecated
public RewardsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RewardsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

RewardsClient

@Deprecated
public RewardsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                     ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RewardsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

RewardsClient

@Deprecated
public RewardsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                     ClientConfiguration configuration,
                     ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RewardsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

RewardsClient

@Deprecated
public RewardsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                     ClientConfiguration configuration,
                     ClientConfigurator clientConfigurator,
                     RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RewardsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

RewardsClient

@Deprecated
public RewardsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                     ClientConfiguration configuration,
                     ClientConfigurator clientConfigurator,
                     RequestSignerFactory defaultRequestSignerFactory,
                     List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RewardsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

RewardsClient

@Deprecated
public RewardsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                     ClientConfiguration configuration,
                     ClientConfigurator clientConfigurator,
                     RequestSignerFactory defaultRequestSignerFactory,
                     List<ClientConfigurator> additionalClientConfigurators,
                     String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RewardsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

RewardsClient

@Deprecated
public RewardsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                     ClientConfiguration configuration,
                     ClientConfigurator clientConfigurator,
                     RequestSignerFactory defaultRequestSignerFactory,
                     Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                     List<ClientConfigurator> additionalClientConfigurators,
                     String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RewardsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static RewardsClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Rewards

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.

Specified by:

setRegion in interface Rewards

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Rewards

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.

Specified by:

setRegion in interface Rewards

Parameters:

regionId - The public region ID.

createRedeemableUser

public CreateRedeemableUserResponse createRedeemableUser(CreateRedeemableUserRequest request)

Description copied from interface: Rewards

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

Specified by:

createRedeemableUser in interface Rewards

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRedeemableUser

public DeleteRedeemableUserResponse deleteRedeemableUser(DeleteRedeemableUserRequest request)

Description copied from interface: Rewards

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

Specified by:

deleteRedeemableUser in interface Rewards

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listProducts

public ListProductsResponse listProducts(ListProductsRequest request)

Description copied from interface: Rewards

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

Specified by:

listProducts in interface Rewards

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRedeemableUsers

public ListRedeemableUsersResponse listRedeemableUsers(ListRedeemableUsersRequest request)

Description copied from interface: Rewards

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

Specified by:

listRedeemableUsers in interface Rewards

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRedemptions

public ListRedemptionsResponse listRedemptions(ListRedemptionsRequest request)

Description copied from interface: Rewards

Returns the list of redemption for the subscription ID.

Specified by:

listRedemptions in interface Rewards

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRewards

public ListRewardsResponse listRewards(ListRewardsRequest request)

Description copied from interface: Rewards

Returns the list of rewards for a subscription ID.

Specified by:

listRewards in interface Rewards

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public RewardsPaginators getPaginators()

Description copied from interface: Rewards

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.

Specified by:

getPaginators in interface Rewards

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()