@Generated(value="OracleSDKGenerator", comments="API Version: 0.0.1") public class AnnouncementSubscriptionClient extends Object implements AnnouncementSubscription
Modifier and Type | Class and Description |
---|---|
static class |
AnnouncementSubscriptionClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for AnnouncementSubscription.
|
Modifier | Constructor and Description |
---|---|
|
AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
AnnouncementSubscriptionClient(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.
|
|
AnnouncementSubscriptionClient(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.
|
|
AnnouncementSubscriptionClient(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 |
AnnouncementSubscriptionClient(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.
|
|
AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static AnnouncementSubscriptionClient.Builder |
builder()
Create a builder for this client.
|
ChangeAnnouncementSubscriptionCompartmentResponse |
changeAnnouncementSubscriptionCompartment(ChangeAnnouncementSubscriptionCompartmentRequest request)
Moves the specified announcement subscription from one compartment to another compartment.
|
void |
close() |
CreateAnnouncementSubscriptionResponse |
createAnnouncementSubscription(CreateAnnouncementSubscriptionRequest request)
Creates a new announcement subscription.
|
CreateFilterGroupResponse |
createFilterGroup(CreateFilterGroupRequest request)
Creates a new filter group in the specified announcement subscription.
|
DeleteAnnouncementSubscriptionResponse |
deleteAnnouncementSubscription(DeleteAnnouncementSubscriptionRequest request)
Deletes the specified announcement subscription.
|
DeleteFilterGroupResponse |
deleteFilterGroup(DeleteFilterGroupRequest request)
Deletes a filter group in the specified announcement subscription.
|
GetAnnouncementSubscriptionResponse |
getAnnouncementSubscription(GetAnnouncementSubscriptionRequest request)
Gets the specified announcement subscription.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
AnnouncementSubscriptionPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
AnnouncementSubscriptionWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListAnnouncementSubscriptionsResponse |
listAnnouncementSubscriptions(ListAnnouncementSubscriptionsRequest request)
Gets a list of all announcement subscriptions in the specified compartment.
|
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’).
|
UpdateAnnouncementSubscriptionResponse |
updateAnnouncementSubscription(UpdateAnnouncementSubscriptionRequest request)
Updates the specified announcement subscription.
|
UpdateFilterGroupResponse |
updateFilterGroup(UpdateFilterGroupRequest request)
Updates a filter group in the specified announcement subscription.
|
public static final Service SERVICE
Service instance for AnnouncementSubscription.
public AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public AnnouncementSubscriptionClient(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.
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.public AnnouncementSubscriptionClient(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.
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.public AnnouncementSubscriptionClient(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.
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.public AnnouncementSubscriptionClient(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.
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
)public AnnouncementSubscriptionClient(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.
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 signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public AnnouncementSubscriptionClient(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.
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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorprotected AnnouncementSubscriptionClient(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 AnnouncementSubscriptionClient.Builder
to get access to all these 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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static AnnouncementSubscriptionClient.Builder builder()
Create a builder for this client.
public void refreshClient()
AnnouncementSubscription
Rebuilds the client from scratch. Useful to refresh certificates.
refreshClient
in interface AnnouncementSubscription
public void setEndpoint(String endpoint)
AnnouncementSubscription
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface AnnouncementSubscription
endpoint
- The endpoint of the service.public String getEndpoint()
AnnouncementSubscription
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface AnnouncementSubscription
public void setRegion(Region region)
AnnouncementSubscription
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 AnnouncementSubscription
region
- The region of the service.public void setRegion(String regionId)
AnnouncementSubscription
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 AnnouncementSubscription
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public ChangeAnnouncementSubscriptionCompartmentResponse changeAnnouncementSubscriptionCompartment(ChangeAnnouncementSubscriptionCompartmentRequest request)
AnnouncementSubscription
Moves the specified announcement subscription from one compartment to another compartment. When provided, If-Match is checked against ETag values of the resource.
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
changeAnnouncementSubscriptionCompartment
in interface AnnouncementSubscription
request
- The request object containing the details to sendpublic CreateAnnouncementSubscriptionResponse createAnnouncementSubscription(CreateAnnouncementSubscriptionRequest request)
AnnouncementSubscription
Creates a new announcement subscription.
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
createAnnouncementSubscription
in interface AnnouncementSubscription
request
- The request object containing the details to sendpublic CreateFilterGroupResponse createFilterGroup(CreateFilterGroupRequest request)
AnnouncementSubscription
Creates a new filter group in the specified announcement subscription.
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
createFilterGroup
in interface AnnouncementSubscription
request
- The request object containing the details to sendpublic DeleteAnnouncementSubscriptionResponse deleteAnnouncementSubscription(DeleteAnnouncementSubscriptionRequest request)
AnnouncementSubscription
Deletes the specified announcement subscription.
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
deleteAnnouncementSubscription
in interface AnnouncementSubscription
request
- The request object containing the details to sendpublic DeleteFilterGroupResponse deleteFilterGroup(DeleteFilterGroupRequest request)
AnnouncementSubscription
Deletes a filter group in the specified announcement subscription.
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
deleteFilterGroup
in interface AnnouncementSubscription
request
- The request object containing the details to sendpublic GetAnnouncementSubscriptionResponse getAnnouncementSubscription(GetAnnouncementSubscriptionRequest request)
AnnouncementSubscription
Gets the specified announcement subscription.
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
getAnnouncementSubscription
in interface AnnouncementSubscription
request
- The request object containing the details to sendpublic ListAnnouncementSubscriptionsResponse listAnnouncementSubscriptions(ListAnnouncementSubscriptionsRequest request)
AnnouncementSubscription
Gets a list of all announcement subscriptions in the specified compartment.
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
listAnnouncementSubscriptions
in interface AnnouncementSubscription
request
- The request object containing the details to sendpublic UpdateAnnouncementSubscriptionResponse updateAnnouncementSubscription(UpdateAnnouncementSubscriptionRequest request)
AnnouncementSubscription
Updates the specified announcement subscription.
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
updateAnnouncementSubscription
in interface AnnouncementSubscription
request
- The request object containing the details to sendpublic UpdateFilterGroupResponse updateFilterGroup(UpdateFilterGroupRequest request)
AnnouncementSubscription
Updates a filter group in the specified announcement subscription.
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
updateFilterGroup
in interface AnnouncementSubscription
request
- The request object containing the details to sendpublic AnnouncementSubscriptionWaiters getWaiters()
AnnouncementSubscription
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface AnnouncementSubscription
public AnnouncementSubscriptionPaginators getPaginators()
AnnouncementSubscription
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 AnnouncementSubscription
Copyright © 2016–2022. All rights reserved.