com.oracle.bmc.announcementsservice

Class AnnouncementSubscriptionClient

java.lang.Object

com.oracle.bmc.announcementsservice.AnnouncementSubscriptionClient

All Implemented Interfaces:

AnnouncementSubscription, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 0.0.1")
public class AnnouncementSubscriptionClient
extends Object
implements AnnouncementSubscription

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnouncementSubscriptionClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for AnnouncementSubscription.

Constructor Summary

Constructors

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.

Method Summary

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.

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 AnnouncementSubscription.

Constructor Detail

AnnouncementSubscriptionClient

public AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

AnnouncementSubscriptionClient

public AnnouncementSubscriptionClient(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.

AnnouncementSubscriptionClient

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.

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.

AnnouncementSubscriptionClient

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.

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.

AnnouncementSubscriptionClient

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.

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.

AnnouncementSubscriptionClient

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.

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)

AnnouncementSubscriptionClient

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.

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)

AnnouncementSubscriptionClient

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.

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

AnnouncementSubscriptionClient

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. 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.

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 AnnouncementSubscriptionClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: AnnouncementSubscription

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface AnnouncementSubscription

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AnnouncementSubscription

Sets the endpoint to call (ex, https://www.example.com).

Specified by:

setEndpoint in interface AnnouncementSubscription

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: AnnouncementSubscription

Gets the set endpoint for REST call (ex, https://www.example.com)

Specified by:

getEndpoint in interface AnnouncementSubscription

setRegion

public void setRegion(Region region)

Description copied from interface: 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.

Specified by:

setRegion in interface AnnouncementSubscription

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: 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.

Specified by:

setRegion in interface AnnouncementSubscription

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

changeAnnouncementSubscriptionCompartment

public ChangeAnnouncementSubscriptionCompartmentResponse changeAnnouncementSubscriptionCompartment(ChangeAnnouncementSubscriptionCompartmentRequest request)

Description copied from interface: 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.

Specified by:

changeAnnouncementSubscriptionCompartment in interface AnnouncementSubscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAnnouncementSubscription

public CreateAnnouncementSubscriptionResponse createAnnouncementSubscription(CreateAnnouncementSubscriptionRequest request)

Description copied from interface: 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.

Specified by:

createAnnouncementSubscription in interface AnnouncementSubscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createFilterGroup

public CreateFilterGroupResponse createFilterGroup(CreateFilterGroupRequest request)

Description copied from interface: 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.

Specified by:

createFilterGroup in interface AnnouncementSubscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAnnouncementSubscription

public DeleteAnnouncementSubscriptionResponse deleteAnnouncementSubscription(DeleteAnnouncementSubscriptionRequest request)

Description copied from interface: 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.

Specified by:

deleteAnnouncementSubscription in interface AnnouncementSubscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteFilterGroup

public DeleteFilterGroupResponse deleteFilterGroup(DeleteFilterGroupRequest request)

Description copied from interface: 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.

Specified by:

deleteFilterGroup in interface AnnouncementSubscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAnnouncementSubscription

public GetAnnouncementSubscriptionResponse getAnnouncementSubscription(GetAnnouncementSubscriptionRequest request)

Description copied from interface: 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.

Specified by:

getAnnouncementSubscription in interface AnnouncementSubscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAnnouncementSubscriptions

public ListAnnouncementSubscriptionsResponse listAnnouncementSubscriptions(ListAnnouncementSubscriptionsRequest request)

Description copied from interface: 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.

Specified by:

listAnnouncementSubscriptions in interface AnnouncementSubscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAnnouncementSubscription

public UpdateAnnouncementSubscriptionResponse updateAnnouncementSubscription(UpdateAnnouncementSubscriptionRequest request)

Description copied from interface: 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.

Specified by:

updateAnnouncementSubscription in interface AnnouncementSubscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateFilterGroup

public UpdateFilterGroupResponse updateFilterGroup(UpdateFilterGroupRequest request)

Description copied from interface: 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.

Specified by:

updateFilterGroup in interface AnnouncementSubscription

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public AnnouncementSubscriptionWaiters getWaiters()

Description copied from interface: AnnouncementSubscription

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

Specified by:

getWaiters in interface AnnouncementSubscription

Returns:

The service waiters.

getPaginators

public AnnouncementSubscriptionPaginators getPaginators()

Description copied from interface: 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.

Specified by:

getPaginators in interface AnnouncementSubscription

Returns:

The service paginators.