@Generated(value="OracleSDKGenerator", comments="API Version: 20200801") public class SubscriptionClient extends BaseSyncClient implements Subscription
Modifier and Type | Class and Description |
---|---|
static class |
SubscriptionClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Subscription.
|
Constructor and 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. |
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.
|
protected ClientConfigurator |
getDefaultConfigurator() |
String |
getEndpoint() |
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 |
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’).
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint
close
public static final Service SERVICE
Service instance for Subscription.
@Deprecated public SubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SubscriptionClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public SubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SubscriptionClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public SubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SubscriptionClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
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
@Deprecated public SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
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
@Deprecated public SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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)
@Deprecated public SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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
@Deprecated public SubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
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
public static SubscriptionClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
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.
setRegion
in interface Subscription
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface Subscription
regionId
- The public region ID.public CreateSubscriptionMappingResponse createSubscriptionMapping(CreateSubscriptionMappingRequest request)
Subscription
Assign the tenancy record identified by the compartment ID to the given subscription ID.
createSubscriptionMapping
in interface Subscription
request
- The request object containing the details to sendpublic DeleteSubscriptionMappingResponse deleteSubscriptionMapping(DeleteSubscriptionMappingRequest request)
Subscription
Delete the subscription mapping details by subscription mapping ID.
deleteSubscriptionMapping
in interface Subscription
request
- The request object containing the details to sendpublic GetAssignedSubscriptionResponse getAssignedSubscription(GetAssignedSubscriptionRequest request)
Subscription
Get the assigned subscription details by assigned subscription ID.
getAssignedSubscription
in interface Subscription
request
- The request object containing the details to sendpublic GetSubscriptionResponse getSubscription(GetSubscriptionRequest request)
Subscription
Gets the subscription details by subscriptionId.
getSubscription
in interface Subscription
request
- The request object containing the details to sendpublic GetSubscriptionMappingResponse getSubscriptionMapping(GetSubscriptionMappingRequest request)
Subscription
Get the subscription mapping details by subscription mapping ID.
getSubscriptionMapping
in interface Subscription
request
- The request object containing the details to sendpublic ListAssignedSubscriptionsResponse listAssignedSubscriptions(ListAssignedSubscriptionsRequest request)
Subscription
Lists subscriptions that are consumed by the compartment. Only the root compartment is allowed.
listAssignedSubscriptions
in interface Subscription
request
- The request object containing the details to sendpublic ListAvailableRegionsResponse listAvailableRegions(ListAvailableRegionsRequest request)
Subscription
List the available regions based on subscription ID.
listAvailableRegions
in interface Subscription
request
- The request object containing the details to sendpublic ListSubscriptionMappingsResponse listSubscriptionMappings(ListSubscriptionMappingsRequest request)
Subscription
Lists the subscription mappings for all the subscriptions owned by a given compartmentId. Only the root compartment is allowed.
listSubscriptionMappings
in interface Subscription
request
- The request object containing the details to sendpublic ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest request)
Subscription
List the subscriptions that a compartment owns. Only the root compartment is allowed.
listSubscriptions
in interface Subscription
request
- The request object containing the details to sendpublic SubscriptionWaiters getWaiters()
Subscription
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Subscription
public SubscriptionPaginators getPaginators()
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.
getPaginators
in interface Subscription
protected ClientConfigurator getDefaultConfigurator()
public final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
Copyright © 2016–2023. All rights reserved.