com.oracle.bmc.announcementsservice

Class AnnouncementsPreferencesClient

java.lang.Object

com.oracle.bmc.announcementsservice.AnnouncementsPreferencesClient

All Implemented Interfaces:

AnnouncementsPreferences, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	AnnouncementsPreferencesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	AnnouncementsPreferencesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	AnnouncementsPreferencesClient(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.
	AnnouncementsPreferencesClient(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.
protected	AnnouncementsPreferencesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	AnnouncementsPreferencesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	AnnouncementsPreferencesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	AnnouncementsPreferencesClient(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 AnnouncementsPreferencesClient.Builder	builder() Create a builder for this client.
void	close()
CreateAnnouncementsPreferenceResponse	createAnnouncementsPreference(CreateAnnouncementsPreferenceRequest request) Creates a request that specifies preferences for the tenancy regarding receiving announcements by email.
GetAnnouncementsPreferenceResponse	getAnnouncementsPreference(GetAnnouncementsPreferenceRequest request) Gets the current preferences of the tenancy regarding receiving announcements by email.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
AnnouncementsPreferencesPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListAnnouncementsPreferencesResponse	listAnnouncementsPreferences(ListAnnouncementsPreferencesRequest request) Gets the current preferences of the tenancy regarding receiving announcements by email.
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’).
UpdateAnnouncementsPreferenceResponse	updateAnnouncementsPreference(UpdateAnnouncementsPreferenceRequest request) Updates the preferences of the tenancy regarding receiving announcements by email.

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

Constructor Detail

AnnouncementsPreferencesClient

public AnnouncementsPreferencesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

AnnouncementsPreferencesClient

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

AnnouncementsPreferencesClient

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

AnnouncementsPreferencesClient

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

AnnouncementsPreferencesClient

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

AnnouncementsPreferencesClient

public AnnouncementsPreferencesClient(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)

AnnouncementsPreferencesClient

public AnnouncementsPreferencesClient(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)

AnnouncementsPreferencesClient

protected AnnouncementsPreferencesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint,
                                         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 AnnouncementsPreferencesClient.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)

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static AnnouncementsPreferencesClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: AnnouncementsPreferences

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface AnnouncementsPreferences

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AnnouncementsPreferences

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

Specified by:

setEndpoint in interface AnnouncementsPreferences

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: AnnouncementsPreferences

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

Specified by:

getEndpoint in interface AnnouncementsPreferences

setRegion

public void setRegion(Region region)

Description copied from interface: AnnouncementsPreferences

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 AnnouncementsPreferences

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: AnnouncementsPreferences

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 AnnouncementsPreferences

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

createAnnouncementsPreference

public CreateAnnouncementsPreferenceResponse createAnnouncementsPreference(CreateAnnouncementsPreferenceRequest request)

Description copied from interface: AnnouncementsPreferences

Creates a request that specifies preferences for the tenancy regarding receiving announcements by email.

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:

createAnnouncementsPreference in interface AnnouncementsPreferences

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAnnouncementsPreference

public GetAnnouncementsPreferenceResponse getAnnouncementsPreference(GetAnnouncementsPreferenceRequest request)

Description copied from interface: AnnouncementsPreferences

Gets the current preferences of the tenancy regarding receiving announcements by email.

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:

getAnnouncementsPreference in interface AnnouncementsPreferences

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAnnouncementsPreferences

public ListAnnouncementsPreferencesResponse listAnnouncementsPreferences(ListAnnouncementsPreferencesRequest request)

Description copied from interface: AnnouncementsPreferences

Gets the current preferences of the tenancy regarding receiving announcements by email.

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:

listAnnouncementsPreferences in interface AnnouncementsPreferences

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAnnouncementsPreference

public UpdateAnnouncementsPreferenceResponse updateAnnouncementsPreference(UpdateAnnouncementsPreferenceRequest request)

Description copied from interface: AnnouncementsPreferences

Updates the preferences of the tenancy regarding receiving announcements by email.

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:

updateAnnouncementsPreference in interface AnnouncementsPreferences

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public AnnouncementsPreferencesPaginators getPaginators()

Description copied from interface: AnnouncementsPreferences

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 AnnouncementsPreferences

Returns:

The service paginators.