Class: OCI::Multicloud::MulticloudAlertsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/multicloud/multicloud_alerts_client.rb

Overview

Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider. For more information, see Oracle Multicloud Hub.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ MulticloudAlertsClient

Creates a new MulticloudAlertsClient. 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.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    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

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    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

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/multicloud/multicloud_alerts_client.rb', line 55

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 + '/20180828'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "MulticloudAlertsClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/multicloud/multicloud_alerts_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/multicloud/multicloud_alerts_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/multicloud/multicloud_alerts_client.rb', line 29

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

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

Returns:



25
26
27
 
# File 'lib/oci/multicloud/multicloud_alerts_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#list_multicloud_alerts(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_multicloud_alerts API.

Gets a list of Multicloud Alerts for a given root compartment. Optional query parameters can be used to filter alerts by resource, subscription, severity, lifecycle state, and alert status.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :resource_id (String) —

    Filter alerts associated with a specific resource OCID.

  • :resource_type (String) —

    Filter alerts by resource type (e.g. ADBD, VMCluster).

  • :alert_type (String) —

    Filter alerts by alert type (e.g. IAM_POLICY_GAP).

  • :alert_function_name (String) —

    Filter alerts generated by a specific internal component (e.g. MCL, BILLING, ORP).

  • :severity (String) —

    Filter alerts by severity. Allowed values are: LOW, MEDIUM, HIGH, CRITICAL

  • :alert_status (String) —

    Filter alerts by alert status. User interaction: ACKNOWLEDGED, UNACKNOWLEDGED System lifecycle: RESOLVED

    Allowed values are: UNACKNOWLEDGED, ACKNOWLEDGED, RESOLVED

  • :subscription_service_name (String) —

    The cloud service provider.

  • :subscription_id (String) —

    The OCID of the Multicloud subscription in which to list resources.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). In general, the sort order is DESC when sorting by time and ASC otherwise.

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/multicloud/multicloud_alerts_client.rb', line 149

def list_multicloud_alerts(compartment_id, opts = {})
  logger.debug 'Calling operation MulticloudAlertsClient#list_multicloud_alerts.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_multicloud_alerts." if compartment_id.nil?

  if opts[:severity] && !%w[LOW MEDIUM HIGH CRITICAL].include?(opts[:severity])
    raise 'Invalid value for "severity", must be one of LOW, MEDIUM, HIGH, CRITICAL.'
  end

  if opts[:alert_status] && !%w[UNACKNOWLEDGED ACKNOWLEDGED RESOLVED].include?(opts[:alert_status])
    raise 'Invalid value for "alert_status", must be one of UNACKNOWLEDGED, ACKNOWLEDGED, RESOLVED.'
  end

  if opts[:subscription_service_name] && !OCI::Multicloud::Models::SUBSCRIPTION_TYPE_ENUM.include?(opts[:subscription_service_name])
    raise 'Invalid value for "subscription_service_name", must be one of the values in OCI::Multicloud::Models::SUBSCRIPTION_TYPE_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  if opts[:sort_order] && !OCI::Multicloud::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Multicloud::Models::SORT_ORDER_ENUM.'
  end

  path = '/multicloudalerts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:resourceType] = opts[:resource_type] if opts[:resource_type]
  query_params[:alertType] = opts[:alert_type] if opts[:alert_type]
  query_params[:alertFunctionName] = opts[:alert_function_name] if opts[:alert_function_name]
  query_params[:severity] = opts[:severity] if opts[:severity]
  query_params[:alertStatus] = opts[:alert_status] if opts[:alert_status]
  query_params[:subscriptionServiceName] = opts[:subscription_service_name] if opts[:subscription_service_name]
  query_params[:subscriptionId] = opts[:subscription_id] if opts[:subscription_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'MulticloudAlertsClient#list_multicloud_alerts') 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::Multicloud::Models::MulticloudAlertCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/multicloud/multicloud_alerts_client.rb', line 94

def logger
  @api_client.config.logger
end