|
| 1 | +/** |
| 2 | + * Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. |
| 4 | + */ |
| 5 | +package com.oracle.bmc.announcementsservice; |
| 6 | + |
| 7 | +import com.oracle.bmc.announcementsservice.requests.*; |
| 8 | +import com.oracle.bmc.announcementsservice.responses.*; |
| 9 | + |
| 10 | +/** |
| 11 | + * Manage Oracle Cloud Infrastructure console announcements. |
| 12 | + */ |
| 13 | +@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 0.0.1") |
| 14 | +public interface AnnouncementsPreferences extends AutoCloseable { |
| 15 | + |
| 16 | + /** |
| 17 | + * Sets the endpoint to call (ex, https://www.example.com). |
| 18 | + * @param endpoint The endpoint of the service. |
| 19 | + */ |
| 20 | + void setEndpoint(String endpoint); |
| 21 | + |
| 22 | + /** |
| 23 | + * Gets the set endpoint for REST call (ex, https://www.example.com) |
| 24 | + */ |
| 25 | + String getEndpoint(); |
| 26 | + |
| 27 | + /** |
| 28 | + * Sets the region to call (ex, Region.US_PHOENIX_1). |
| 29 | + * <p> |
| 30 | + * Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised. |
| 31 | + * @param region The region of the service. |
| 32 | + */ |
| 33 | + void setRegion(com.oracle.bmc.Region region); |
| 34 | + |
| 35 | + /** |
| 36 | + * Sets the region to call (ex, 'us-phoenix-1'). |
| 37 | + * <p> |
| 38 | + * Note, this will first try to map the region ID to a known Region and call |
| 39 | + * {@link #setRegion(Region) setRegion}. |
| 40 | + * <p> |
| 41 | + * If no known Region could be determined, it will create an endpoint based on the |
| 42 | + * default endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)} |
| 43 | + * and then call {@link #setEndpoint(String) setEndpoint}. |
| 44 | + * @param regionId The public region ID. |
| 45 | + */ |
| 46 | + void setRegion(String regionId); |
| 47 | + |
| 48 | + /** |
| 49 | + * Creates a request that specifies preferences for the tenancy regarding receiving announcements by email. |
| 50 | + * |
| 51 | + * @param request The request object containing the details to send |
| 52 | + * @return A response object containing details about the completed operation |
| 53 | + * @throws BmcException when an error occurs. |
| 54 | + * |
| 55 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/announcementsservice/CreateAnnouncementsPreferenceExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use CreateAnnouncementsPreference API. |
| 56 | + */ |
| 57 | + CreateAnnouncementsPreferenceResponse createAnnouncementsPreference( |
| 58 | + CreateAnnouncementsPreferenceRequest request); |
| 59 | + |
| 60 | + /** |
| 61 | + * Gets the current preferences of the tenancy regarding receiving announcements by email. |
| 62 | + * |
| 63 | + * @param request The request object containing the details to send |
| 64 | + * @return A response object containing details about the completed operation |
| 65 | + * @throws BmcException when an error occurs. |
| 66 | + * |
| 67 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/announcementsservice/GetAnnouncementsPreferenceExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use GetAnnouncementsPreference API. |
| 68 | + */ |
| 69 | + GetAnnouncementsPreferenceResponse getAnnouncementsPreference( |
| 70 | + GetAnnouncementsPreferenceRequest request); |
| 71 | + |
| 72 | + /** |
| 73 | + * Gets the current preferences of the tenancy regarding receiving announcements by email. |
| 74 | + * |
| 75 | + * @param request The request object containing the details to send |
| 76 | + * @return A response object containing details about the completed operation |
| 77 | + * @throws BmcException when an error occurs. |
| 78 | + * |
| 79 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/announcementsservice/ListAnnouncementsPreferencesExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ListAnnouncementsPreferences API. |
| 80 | + */ |
| 81 | + ListAnnouncementsPreferencesResponse listAnnouncementsPreferences( |
| 82 | + ListAnnouncementsPreferencesRequest request); |
| 83 | + |
| 84 | + /** |
| 85 | + * Updates the preferences of the tenancy regarding receiving announcements by email. |
| 86 | + * |
| 87 | + * @param request The request object containing the details to send |
| 88 | + * @return A response object containing details about the completed operation |
| 89 | + * @throws BmcException when an error occurs. |
| 90 | + * |
| 91 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/announcementsservice/UpdateAnnouncementsPreferenceExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use UpdateAnnouncementsPreference API. |
| 92 | + */ |
| 93 | + UpdateAnnouncementsPreferenceResponse updateAnnouncementsPreference( |
| 94 | + UpdateAnnouncementsPreferenceRequest request); |
| 95 | + |
| 96 | + /** |
| 97 | + * Gets the pre-configured paginators available for list operations in this service which may return multiple |
| 98 | + * pages of data. These paginators provide an {@link java.lang.Iterable} interface so that service responses, or |
| 99 | + * resources/records, can be iterated through without having to manually deal with pagination and page tokens. |
| 100 | + * |
| 101 | + * @return The service paginators. |
| 102 | + */ |
| 103 | + AnnouncementsPreferencesPaginators getPaginators(); |
| 104 | +} |
0 commit comments