Package com.oracle.bmc.tenantmanagercontrolplane

Class SubscriptionClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.tenantmanagercontrolplane.SubscriptionClient

All Implemented Interfaces:

Subscription, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230401")
public class SubscriptionClient
extends BaseSyncClient
implements Subscription

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SubscriptionClient.Builder	builder()	Create a builder for this client.
void	close()
CreateSubscriptionMappingResponse	createSubscriptionMapping(CreateSubscriptionMappingRequest request)	Assign the tenancy record identified by the compartment ID to the given subscription ID.
DeleteSubscriptionMappingResponse	deleteSubscriptionMapping(DeleteSubscriptionMappingRequest request)	Delete the subscription mapping details by subscription mapping ID.
void	enableDualStackEndpoints(boolean enableDualStackEndpoints)	This method should be used to enable or disable the use of dual-stack endpoints.
GetAssignedSubscriptionResponse	getAssignedSubscription(GetAssignedSubscriptionRequest request)	Get the assigned subscription details by assigned subscription ID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()	Get the endpoint of the client.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Map<String,Boolean>	getOptionsMap()	Return an immutable snapshot representing the current options set for this client.
SubscriptionPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
String	getResolvedEndpoint(Map<String,Object> requiredParametersMap)	Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
GetSubscriptionResponse	getSubscription(GetSubscriptionRequest request)	Gets the subscription details by subscription ID.
GetSubscriptionMappingResponse	getSubscriptionMapping(GetSubscriptionMappingRequest request)	Get the subscription mapping details by subscription mapping ID.
SubscriptionWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListAssignedSubscriptionLineItemsResponse	listAssignedSubscriptionLineItems(ListAssignedSubscriptionLineItemsRequest request)	List line item summaries that a assigned subscription owns.
ListAssignedSubscriptionsResponse	listAssignedSubscriptions(ListAssignedSubscriptionsRequest request)	Lists subscriptions that are consumed by the compartment.
ListAvailableRegionsResponse	listAvailableRegions(ListAvailableRegionsRequest request)	List the available regions based on subscription ID.
ListSubscriptionLineItemsResponse	listSubscriptionLineItems(ListSubscriptionLineItemsRequest request)	Lists the line items in a subscription.
ListSubscriptionMappingsResponse	listSubscriptionMappings(ListSubscriptionMappingsRequest request)	Lists the subscription mappings for all the subscriptions owned by a given compartmentId.
ListSubscriptionsResponse	listSubscriptions(ListSubscriptionsRequest request)	List the subscriptions that a compartment owns.
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	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.tenantmanagercontrolplane.Subscription

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Subscription.

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

SubscriptionClient

@Deprecated
public SubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

SubscriptionClient

@Deprecated
public SubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

SubscriptionClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

SubscriptionClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

SubscriptionClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

SubscriptionClient

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

SubscriptionClient

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

SubscriptionClient

@Deprecated
public SubscriptionClient(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 SubscriptionClient.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 - SubscriptionClient.Builder.executorService

Method Detail

builder

public static SubscriptionClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Subscription

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 Subscription

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Subscription

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 Subscription

Parameters:

regionId - The public region ID.

createSubscriptionMapping

public CreateSubscriptionMappingResponse createSubscriptionMapping(CreateSubscriptionMappingRequest request)

Description copied from interface: Subscription

Assign the tenancy record identified by the compartment ID to the given subscription ID.

Specified by:

createSubscriptionMapping in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteSubscriptionMapping

public DeleteSubscriptionMappingResponse deleteSubscriptionMapping(DeleteSubscriptionMappingRequest request)

Description copied from interface: Subscription

Delete the subscription mapping details by subscription mapping ID.

Specified by:

deleteSubscriptionMapping in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAssignedSubscription

public GetAssignedSubscriptionResponse getAssignedSubscription(GetAssignedSubscriptionRequest request)

Description copied from interface: Subscription

Get the assigned subscription details by assigned subscription ID.

Specified by:

getAssignedSubscription in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSubscription

public GetSubscriptionResponse getSubscription(GetSubscriptionRequest request)

Description copied from interface: Subscription

Gets the subscription details by subscription ID.

Specified by:

getSubscription in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSubscriptionMapping

public GetSubscriptionMappingResponse getSubscriptionMapping(GetSubscriptionMappingRequest request)

Description copied from interface: Subscription

Get the subscription mapping details by subscription mapping ID.

Specified by:

getSubscriptionMapping in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAssignedSubscriptionLineItems

public ListAssignedSubscriptionLineItemsResponse listAssignedSubscriptionLineItems(ListAssignedSubscriptionLineItemsRequest request)

Description copied from interface: Subscription

List line item summaries that a assigned subscription owns.

Specified by:

listAssignedSubscriptionLineItems in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAssignedSubscriptions

public ListAssignedSubscriptionsResponse listAssignedSubscriptions(ListAssignedSubscriptionsRequest request)

Description copied from interface: Subscription

Lists subscriptions that are consumed by the compartment.

Only the root compartment is allowed.

Specified by:

listAssignedSubscriptions in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAvailableRegions

public ListAvailableRegionsResponse listAvailableRegions(ListAvailableRegionsRequest request)

Description copied from interface: Subscription

List the available regions based on subscription ID.

Specified by:

listAvailableRegions in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSubscriptionLineItems

public ListSubscriptionLineItemsResponse listSubscriptionLineItems(ListSubscriptionLineItemsRequest request)

Description copied from interface: Subscription

Lists the line items in a subscription.

Specified by:

listSubscriptionLineItems in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSubscriptionMappings

public ListSubscriptionMappingsResponse listSubscriptionMappings(ListSubscriptionMappingsRequest request)

Description copied from interface: Subscription

Lists the subscription mappings for all the subscriptions owned by a given compartmentId.

Only the root compartment is allowed.

Specified by:

listSubscriptionMappings in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSubscriptions

public ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest request)

Description copied from interface: Subscription

List the subscriptions that a compartment owns.

Only the root compartment is allowed.

Specified by:

listSubscriptions in interface Subscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public SubscriptionWaiters getWaiters()

Description copied from interface: Subscription

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

Specified by:

getWaiters in interface Subscription

Returns:

The service waiters.

getPaginators

public SubscriptionPaginators getPaginators()

Description copied from interface: Subscription

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 Subscription

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

enableDualStackEndpoints

public void enableDualStackEndpoints(boolean enableDualStackEndpoints)

This method should be used to enable or disable the use of dual-stack endpoints.

The default value is false i.e. dual-stack endpoints are disabled by default.

Parameters:

enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively

getOptionsMap

public Map<String,Boolean> getOptionsMap()

Return an immutable snapshot representing the current options set for this client.

Returns:

immutable snapshot representing the current options set for this client

getResolvedEndpoint

public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)

Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.

Parameters:

requiredParametersMap - the map from required parameter name to their values

Returns:

resolved endpoint, with all options and placeholders filled in

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

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

Get the endpoint of the client.

Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.

Examples of endpoints this may return:

• Unparameterized endpoints

               https://identity.us-phoenix-1.oci.oraclecloud.com
               https://identity.us-ashburn-1.oci.oraclecloud.com
               https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
           

• Parameterized endpoints with placeholders

               https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com
               https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
           

• Parameterized endpoints with options

               https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com
               https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
           

• Parameterized endpoints with placeholders and options

               https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com
               https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
           

To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).

Returns:

the endpoint being used by the client

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