com.oracle.bmc.announcementsservice

Class AnnouncementSubscriptionClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.announcementsservice.AnnouncementSubscriptionClient

All Implemented Interfaces:

AnnouncementSubscription, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 0.0.1")
public class AnnouncementSubscriptionClient
extends BaseSyncClient
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

Constructor and Description
AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

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.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
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’).
UpdateAnnouncementSubscriptionResponse	updateAnnouncementSubscription(UpdateAnnouncementSubscriptionRequest request) Updates the specified announcement subscription.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateFilterGroupResponse	updateFilterGroup(UpdateFilterGroupRequest request) Updates a filter group in the specified announcement subscription.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.announcementsservice.AnnouncementSubscription

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for AnnouncementSubscription.

Constructor Detail

AnnouncementSubscriptionClient

@Deprecated
public AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnnouncementSubscriptionClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

AnnouncementSubscriptionClient

@Deprecated
public AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                  ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnnouncementSubscriptionClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

AnnouncementSubscriptionClient

@Deprecated
public AnnouncementSubscriptionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                  ClientConfiguration configuration,
                                                  ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnnouncementSubscriptionClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

AnnouncementSubscriptionClient

@Deprecated
public AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                  ClientConfiguration configuration,
                                                  ClientConfigurator clientConfigurator,
                                                  RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnnouncementSubscriptionClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

AnnouncementSubscriptionClient

@Deprecated
public AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                  ClientConfiguration configuration,
                                                  ClientConfigurator clientConfigurator,
                                                  RequestSignerFactory defaultRequestSignerFactory,
                                                  List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnnouncementSubscriptionClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

AnnouncementSubscriptionClient

@Deprecated
public AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                  ClientConfiguration configuration,
                                                  ClientConfigurator clientConfigurator,
                                                  RequestSignerFactory defaultRequestSignerFactory,
                                                  List<ClientConfigurator> additionalClientConfigurators,
                                                  String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnnouncementSubscriptionClient.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)

AnnouncementSubscriptionClient

@Deprecated
public AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                  ClientConfiguration configuration,
                                                  ClientConfigurator clientConfigurator,
                                                  RequestSignerFactory defaultRequestSignerFactory,
                                                  Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                                  List<ClientConfigurator> additionalClientConfigurators,
                                                  String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnnouncementSubscriptionClient.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

AnnouncementSubscriptionClient

@Deprecated
public AnnouncementSubscriptionClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                  ClientConfiguration configuration,
                                                  ClientConfigurator clientConfigurator,
                                                  RequestSignerFactory defaultRequestSignerFactory,
                                                  Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                                  List<ClientConfigurator> additionalClientConfigurators,
                                                  String endpoint,
                                                  ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnnouncementSubscriptionClient.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 - AnnouncementSubscriptionClient.Builder.executorService

Method Detail

builder

public static AnnouncementSubscriptionClient.Builder builder()

Create a builder for this client.

Returns:

builder

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.

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable