class OCI::AnnouncementsService::AnnouncementsPreferencesClient
Manage Oracle Cloud Infrastructure console announcements.
Attributes
Client used to make HTTP requests. @return [OCI::ApiClient]
Fully qualified endpoint URL @return [String]
The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries @return [OCI::Retry::RetryConfig]
Public Class Methods
Creates a new AnnouncementsPreferencesClient
. Notes:
If a config is not specified, then the global OCI.config will be used. This client is not thread-safe Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
@param [Config] config A Config
object. @param [String] region A region used to determine the service endpoint. This will usually
correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then
a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client
@param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests
the details for the proxy can be provided in this parameter
@param [OCI::Retry::RetryConfig] retry_config
The retry configuration for this service client. This represents the default retry configuration to
apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries
# File lib/oci/announcements_service/announcements_preferences_client.rb, line 53 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20180904' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "AnnouncementsPreferencesClient endpoint set to '#{@endpoint}'." if logger end
Public Instance Methods
Creates a request that specifies preferences for the tenancy regarding receiving announcements by email.
@param [OCI::AnnouncementsService::Models::CreateAnnouncementsPreferencesDetails] announcements_preference_details The object that contains details about tenancy preferences for receiving announcements by email. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the complete request ID.
@option opts [String] :opc_retry_token Idempotency token @return [Response] A Response
object with data of type {OCI::AnnouncementsService::Models::AnnouncementsPreferencesSummary AnnouncementsPreferencesSummary} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/announcementsservice/create_announcements_preference.rb.html) to see an example of how to use create_announcements_preference
API.
# File lib/oci/announcements_service/announcements_preferences_client.rb, line 113 def create_announcements_preference(announcements_preference_details, opts = {}) logger.debug 'Calling operation AnnouncementsPreferencesClient#create_announcements_preference.' if logger raise "Missing the required parameter 'announcements_preference_details' when calling create_announcements_preference." if announcements_preference_details.nil? path = '/announcementsPreferences' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(announcements_preference_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementsPreferencesClient#create_announcements_preference') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AnnouncementsService::Models::AnnouncementsPreferencesSummary' ) end # rubocop:enable Metrics/BlockLength end
Gets the current preferences of the tenancy regarding receiving announcements by email.
@param [String] preference_id The ID of the preference. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the complete request ID.
@return [Response] A Response
object with data of type {OCI::AnnouncementsService::Models::AnnouncementsPreferences AnnouncementsPreferences} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/announcementsservice/get_announcements_preference.rb.html) to see an example of how to use get_announcements_preference
API.
# File lib/oci/announcements_service/announcements_preferences_client.rb, line 171 def get_announcements_preference(preference_id, opts = {}) logger.debug 'Calling operation AnnouncementsPreferencesClient#get_announcements_preference.' if logger raise "Missing the required parameter 'preference_id' when calling get_announcements_preference." if preference_id.nil? raise "Parameter value for 'preference_id' must not be blank" if OCI::Internal::Util.blank_string?(preference_id) path = '/announcementsPreferences/{preferenceId}'.sub('{preferenceId}', preference_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementsPreferencesClient#get_announcements_preference') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AnnouncementsService::Models::AnnouncementsPreferences' ) end # rubocop:enable Metrics/BlockLength end
Gets the current preferences of the tenancy regarding receiving announcements by email.
@param [String] compartment_id The OCID of the compartment. Because announcements are specific to a tenancy, this is the
OCID of the root compartment.
@param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [Integer] :limit The maximum number of items to return in a paginated "List" call. @option opts [String] :page The value of the `opc-next-page` response header from the previous "List" call. @option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the complete request ID.
@return [Response] A Response
object with data of type Array<{OCI::AnnouncementsService::Models::AnnouncementsPreferencesSummary AnnouncementsPreferencesSummary}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/announcementsservice/list_announcements_preferences.rb.html) to see an example of how to use list_announcements_preferences
API.
# File lib/oci/announcements_service/announcements_preferences_client.rb, line 232 def list_announcements_preferences(compartment_id, opts = {}) logger.debug 'Calling operation AnnouncementsPreferencesClient#list_announcements_preferences.' if logger raise "Missing the required parameter 'compartment_id' when calling list_announcements_preferences." if compartment_id.nil? path = '/announcementsPreferences' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementsPreferencesClient#list_announcements_preferences') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::AnnouncementsService::Models::AnnouncementsPreferencesSummary>' ) end # rubocop:enable Metrics/BlockLength end
@return [Logger] The logger for this client. May be nil.
# File lib/oci/announcements_service/announcements_preferences_client.rb, line 92 def logger @api_client.config.logger end
Set the region that will be used to determine the service endpoint. This will usually correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
# File lib/oci/announcements_service/announcements_preferences_client.rb, line 82 def region=(new_region) @region = new_region raise 'A region must be specified.' unless @region @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://announcements.{region}.{secondLevelDomain}') + '/20180904' logger.info "AnnouncementsPreferencesClient endpoint set to '#{@endpoint} from region #{@region}'." if logger end
Updates the preferences of the tenancy regarding receiving announcements by email.
@param [String] preference_id The ID of the preference. @param [OCI::AnnouncementsService::Models::UpdateAnnouncementsPreferencesDetails] announcements_preference_details The object that contains details about tenancy preferences for receiving announcements by email. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the complete request ID.
@option opts [String] :if_match The locking version, used for optimistic concurrency control. @return [Response] A Response
object with data of type {OCI::AnnouncementsService::Models::AnnouncementsPreferencesSummary AnnouncementsPreferencesSummary} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/announcementsservice/update_announcements_preference.rb.html) to see an example of how to use update_announcements_preference
API.
# File lib/oci/announcements_service/announcements_preferences_client.rb, line 293 def update_announcements_preference(preference_id, announcements_preference_details, opts = {}) logger.debug 'Calling operation AnnouncementsPreferencesClient#update_announcements_preference.' if logger raise "Missing the required parameter 'preference_id' when calling update_announcements_preference." if preference_id.nil? raise "Missing the required parameter 'announcements_preference_details' when calling update_announcements_preference." if announcements_preference_details.nil? raise "Parameter value for 'preference_id' must not be blank" if OCI::Internal::Util.blank_string?(preference_id) path = '/announcementsPreferences/{preferenceId}'.sub('{preferenceId}', preference_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(announcements_preference_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementsPreferencesClient#update_announcements_preference') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AnnouncementsService::Models::AnnouncementsPreferencesSummary' ) end # rubocop:enable Metrics/BlockLength end
Private Instance Methods
rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines
# File lib/oci/announcements_service/announcements_preferences_client.rb, line 338 def applicable_retry_config(opts = {}) return @retry_config unless opts.key?(:retry_config) opts[:retry_config] end