Package com.oracle.bmc.apigateway

Class UsagePlansClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.apigateway.UsagePlansClient

All Implemented Interfaces:

UsagePlans, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public class UsagePlansClient
extends BaseSyncClient
implements UsagePlans

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UsagePlansClient.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 UsagePlans.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AddUsagePlanLockResponse	addUsagePlanLock(AddUsagePlanLockRequest request)	Adds a lock to a UsagePlan resource.
static UsagePlansClient.Builder	builder()	Create a builder for this client.
ChangeUsagePlanCompartmentResponse	changeUsagePlanCompartment(ChangeUsagePlanCompartmentRequest request)	Changes the usage plan compartment.
void	close()
CreateUsagePlanResponse	createUsagePlan(CreateUsagePlanRequest request)	Creates a new usage plan.
DeleteUsagePlanResponse	deleteUsagePlan(DeleteUsagePlanRequest request)	Deletes the usage plan with the given identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
UsagePlansPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetUsagePlanResponse	getUsagePlan(GetUsagePlanRequest request)	Gets a usage plan by identifier.
UsagePlansWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListUsagePlansResponse	listUsagePlans(ListUsagePlansRequest request)	Returns a list of usage plans.
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.
RemoveUsagePlanLockResponse	removeUsagePlanLock(RemoveUsagePlanLockRequest request)	Removes a lock from a UsagePlan resource.
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.
UpdateUsagePlanResponse	updateUsagePlan(UpdateUsagePlanRequest request)	Updates the usage plan with the given identifier.
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.apigateway.UsagePlans

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for UsagePlans.

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

UsagePlansClient

@Deprecated
public UsagePlansClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

UsagePlansClient

@Deprecated
public UsagePlansClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

UsagePlansClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

UsagePlansClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

UsagePlansClient

@Deprecated
public UsagePlansClient(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 UsagePlansClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

UsagePlansClient

@Deprecated
public UsagePlansClient(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 UsagePlansClient.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)

UsagePlansClient

@Deprecated
public UsagePlansClient(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 UsagePlansClient.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

UsagePlansClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see UsagePlansClient.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

executorService - UsagePlansClient.Builder.executorService

Method Detail

builder

public static UsagePlansClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: UsagePlans

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 UsagePlans

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: UsagePlans

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 UsagePlans

Parameters:

regionId - The public region ID.

addUsagePlanLock

public AddUsagePlanLockResponse addUsagePlanLock(AddUsagePlanLockRequest request)

Description copied from interface: UsagePlans

Adds a lock to a UsagePlan resource.

Specified by:

addUsagePlanLock in interface UsagePlans

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeUsagePlanCompartment

public ChangeUsagePlanCompartmentResponse changeUsagePlanCompartment(ChangeUsagePlanCompartmentRequest request)

Description copied from interface: UsagePlans

Changes the usage plan compartment.

Specified by:

changeUsagePlanCompartment in interface UsagePlans

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createUsagePlan

public CreateUsagePlanResponse createUsagePlan(CreateUsagePlanRequest request)

Description copied from interface: UsagePlans

Creates a new usage plan.

Specified by:

createUsagePlan in interface UsagePlans

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteUsagePlan

public DeleteUsagePlanResponse deleteUsagePlan(DeleteUsagePlanRequest request)

Description copied from interface: UsagePlans

Deletes the usage plan with the given identifier.

Specified by:

deleteUsagePlan in interface UsagePlans

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getUsagePlan

public GetUsagePlanResponse getUsagePlan(GetUsagePlanRequest request)

Description copied from interface: UsagePlans

Gets a usage plan by identifier.

Specified by:

getUsagePlan in interface UsagePlans

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listUsagePlans

public ListUsagePlansResponse listUsagePlans(ListUsagePlansRequest request)

Description copied from interface: UsagePlans

Returns a list of usage plans.

Specified by:

listUsagePlans in interface UsagePlans

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeUsagePlanLock

public RemoveUsagePlanLockResponse removeUsagePlanLock(RemoveUsagePlanLockRequest request)

Description copied from interface: UsagePlans

Removes a lock from a UsagePlan resource.

Specified by:

removeUsagePlanLock in interface UsagePlans

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateUsagePlan

public UpdateUsagePlanResponse updateUsagePlan(UpdateUsagePlanRequest request)

Description copied from interface: UsagePlans

Updates the usage plan with the given identifier.

Specified by:

updateUsagePlan in interface UsagePlans

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public UsagePlansWaiters getWaiters()

Description copied from interface: UsagePlans

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface UsagePlans

Returns:

The service waiters.

getPaginators

public UsagePlansPaginators getPaginators()

Description copied from interface: UsagePlans

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 UsagePlans

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()