SubscriptionClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.tenantmanagercontrolplane.SubscriptionClient

All Implemented Interfaces:: Subscription, AutoCloseable

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SubscriptionClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SubscriptionClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for Subscription.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for Subscription.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`SubscriptionClient(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.
	`SubscriptionClient(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.
	`SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`SubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`SubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`SubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`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 subscriptionId.
`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.
`ListAssignedSubscriptionsResponse`	`listAssignedSubscriptions(ListAssignedSubscriptionsRequest request)` Lists subscriptions that are consumed by the compartment.
`ListAvailableRegionsResponse`	`listAvailableRegions(ListAvailableRegionsRequest request)` List the available regions based on subscription ID.
`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`	`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 Subscription.
- Constructor Detail
  - SubscriptionClient
```
public SubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - SubscriptionClient
```
public SubscriptionClient(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.
  - SubscriptionClient
```
public SubscriptionClient(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.
  - SubscriptionClient
```
public SubscriptionClient(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.
  - SubscriptionClient
```
public SubscriptionClient(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.
  - SubscriptionClient
```
public SubscriptionClient(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)
  - SubscriptionClient
```
public SubscriptionClient(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)
  - SubscriptionClient
```
public SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint,
                          ExecutorService executorService)
```
    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)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
  - SubscriptionClient
```
protected SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint,
                             ExecutorService executorService,
                             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 SubscriptionClient.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)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static SubscriptionClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: Subscription
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface Subscription
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: Subscription
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface Subscription
  - 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.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - 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 subscriptionId.
    
    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
  - 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
  - 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.

Class SubscriptionClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

SubscriptionClient

SubscriptionClient

SubscriptionClient

SubscriptionClient

SubscriptionClient

SubscriptionClient

SubscriptionClient

SubscriptionClient

SubscriptionClient

Method Detail

builder

setEndpoint

getEndpoint

setRegion

setRegion

close

createSubscriptionMapping

deleteSubscriptionMapping

getAssignedSubscription

getSubscription

getSubscriptionMapping

listAssignedSubscriptions

listAvailableRegions

listSubscriptionMappings

listSubscriptions

getWaiters

getPaginators