com.oracle.bmc.tenantmanagercontrolplane

Class OrdersClient

java.lang.Object

com.oracle.bmc.tenantmanagercontrolplane.OrdersClient

All Implemented Interfaces:

Orders, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200801")
public class OrdersClient
extends Object
implements Orders

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for Orders.

Constructor Summary

Constructors

Modifier	Constructor and Description
	OrdersClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	OrdersClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	OrdersClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	OrdersClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
protected	OrdersClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	OrdersClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	OrdersClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	OrdersClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
ActivateOrderResponse	activateOrder(ActivateOrderRequest request) Triggers an order activation workflow on behalf of the tenant, given by compartment ID in the body.
static OrdersClient.Builder	builder() Create a builder for this client.
void	close()
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetOrderResponse	getOrder(GetOrderRequest request) Returns the Order Details given by the order ID in the JWT.
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’).

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Orders.

Constructor Detail

OrdersClient

public OrdersClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

OrdersClient

public OrdersClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration)

Creates a new service instance using the given authentication provider and client configuration.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

OrdersClient

public OrdersClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

OrdersClient

public OrdersClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

OrdersClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

OrdersClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

OrdersClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

OrdersClient

protected OrdersClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint,
                       RestClientFactoryBuilder restClientFactoryBuilder)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed. Use the OrdersClient.Builder to get access to all these parameters.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static OrdersClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: Orders

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface Orders

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: Orders

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

Specified by:

setEndpoint in interface Orders

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: Orders

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

Specified by:

getEndpoint in interface Orders

setRegion

public void setRegion(Region region)

Description copied from interface: Orders

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 Orders

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Orders

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 Orders

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

activateOrder

public ActivateOrderResponse activateOrder(ActivateOrderRequest request)

Description copied from interface: Orders

Triggers an order activation workflow on behalf of the tenant, given by compartment ID in the body.

Specified by:

activateOrder in interface Orders

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOrder

public GetOrderResponse getOrder(GetOrderRequest request)

Description copied from interface: Orders

Returns the Order Details given by the order ID in the JWT.

Specified by:

getOrder in interface Orders

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation