com.oracle.bmc.tenantmanagercontrolplane

Interface Subscription

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SubscriptionClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230401")
public interface Subscription
extends AutoCloseable

Use the Organizations API to consolidate multiple OCI tenancies into an organization, and centrally manage your tenancies and organization resources. For more information, see Organization Management Overview. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
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.
GetAssignedSubscriptionResponse	getAssignedSubscription(GetAssignedSubscriptionRequest request) Get the assigned subscription details by assigned subscription ID.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
SubscriptionPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
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() 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 service.

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

createSubscriptionMapping

CreateSubscriptionMappingResponse createSubscriptionMapping(CreateSubscriptionMappingRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateSubscriptionMapping API.

deleteSubscriptionMapping

DeleteSubscriptionMappingResponse deleteSubscriptionMapping(DeleteSubscriptionMappingRequest request)

Delete the subscription mapping details by subscription mapping ID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteSubscriptionMapping API.

getAssignedSubscription

GetAssignedSubscriptionResponse getAssignedSubscription(GetAssignedSubscriptionRequest request)

Get the assigned subscription details by assigned subscription ID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetAssignedSubscription API.

getSubscription

GetSubscriptionResponse getSubscription(GetSubscriptionRequest request)

Gets the subscription details by subscription ID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetSubscription API.

getSubscriptionMapping

GetSubscriptionMappingResponse getSubscriptionMapping(GetSubscriptionMappingRequest request)

Get the subscription mapping details by subscription mapping ID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetSubscriptionMapping API.

listAssignedSubscriptionLineItems

ListAssignedSubscriptionLineItemsResponse listAssignedSubscriptionLineItems(ListAssignedSubscriptionLineItemsRequest request)

List line item summaries that a assigned subscription owns.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListAssignedSubscriptionLineItems API.

listAssignedSubscriptions

ListAssignedSubscriptionsResponse listAssignedSubscriptions(ListAssignedSubscriptionsRequest request)

Lists subscriptions that are consumed by the compartment. Only the root compartment is allowed.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListAssignedSubscriptions API.

listAvailableRegions

ListAvailableRegionsResponse listAvailableRegions(ListAvailableRegionsRequest request)

List the available regions based on subscription ID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListAvailableRegions API.

listSubscriptionLineItems

ListSubscriptionLineItemsResponse listSubscriptionLineItems(ListSubscriptionLineItemsRequest request)

Lists the line items in a subscription.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListSubscriptionLineItems API.

listSubscriptionMappings

ListSubscriptionMappingsResponse listSubscriptionMappings(ListSubscriptionMappingsRequest request)

Lists the subscription mappings for all the subscriptions owned by a given compartmentId. Only the root compartment is allowed.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListSubscriptionMappings API.

listSubscriptions

ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest request)

List the subscriptions that a compartment owns. Only the root compartment is allowed.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListSubscriptions API.

getWaiters

SubscriptionWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

SubscriptionPaginators getPaginators()

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.

Returns:

The service paginators.