Class: OCI::Multicloud::MetadataClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/multicloud/metadata_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) ⇒ MetadataClient

Creates a new MetadataClient. 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/metadata_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 "MetadataClient 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/metadata_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/metadata_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/metadata_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/metadata_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#list_external_location_details_metadata(subscription_id, subscription_service_name, opts = {}) ⇒ Response

Note:

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

List externalLocationDetail metadata from OCI to Cloud Service Provider for regions, Availability Zones, and Cluster Placement Group ID.

Parameters:

  • subscription_id (String) —

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

  • subscription_service_name (String) —

    The cloud service provider.

  • 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

  • :entity_type (String) —

    The resource type query (for example, dbsystem or instance). Allowed values are: dbsystem

  • :compartment_id (String) —

    The OCID of the Multicloud base compartment in which to list resources. A Multicloud base compartment is an OCI compartment that maps to a subscription in a cloud service provider (such as Azure or AWS).

  • :linked_compartment_id (String) —

    The OCID of the compartment linked to the resource.

  • :external_location (String) —

    The cloud service provider region.

  • :logical_zone (String) —

    OCI logical availability domain (AD) to filter the response.

  • :cluster_placement_group_id (String) —

    The OCID of the cluster placement group.

  • :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.

  • :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.

  • :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

  • :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.

Returns:



141
142
143
144
145
146
147
148
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
 
# File 'lib/oci/multicloud/metadata_client.rb', line 141

def list_external_location_details_metadata(subscription_id, subscription_service_name, opts = {})
  logger.debug 'Calling operation MetadataClient#list_external_location_details_metadata.' if logger

  raise "Missing the required parameter 'subscription_id' when calling list_external_location_details_metadata." if subscription_id.nil?
  raise "Missing the required parameter 'subscription_service_name' when calling list_external_location_details_metadata." if subscription_service_name.nil?
  unless OCI::Multicloud::Models::SUBSCRIPTION_TYPE_ENUM.include?(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[:entity_type] && !%w[dbsystem].include?(opts[:entity_type])
    raise 'Invalid value for "entity_type", must be one of dbsystem.'
  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

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

  path = '/externalLocationsMetadata'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:subscriptionId] = subscription_id
  query_params[:subscriptionServiceName] = subscription_service_name
  query_params[:entityType] = opts[:entity_type] if opts[:entity_type]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:linkedCompartmentId] = opts[:linked_compartment_id] if opts[:linked_compartment_id]
  query_params[:externalLocation] = opts[:external_location] if opts[:external_location]
  query_params[:logicalZone] = opts[:logical_zone] if opts[:logical_zone]
  query_params[:clusterPlacementGroupId] = opts[:cluster_placement_group_id] if opts[:cluster_placement_group_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'MetadataClient#list_external_location_details_metadata') 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::ExternalLocationsMetadatumCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_location_mapping_metadata(subscription_service_name, compartment_id, opts = {}) ⇒ Response

Note:

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

List mapped partner cloud regions and zones across cloud service providers for the specified Multicloud base compartment and subscription service name. Each mapping includes the OCI region, logical availability domain, and physical availability domain, along with mapped partner cloud details that depend on the partner cloud. For example, Azure includes a logical zone while AWS doesn't. For more information, see Cross-Cloud Region-Zone Mapping.

Parameters:

  • subscription_service_name (Array<String>) —

    The cloud service provider. Allowed values are: ORACLEDBATAZURE, ORACLEDBATGOOGLE, ORACLEDBATAWS

  • compartment_id (String) —

    The OCID of the Multicloud base compartment in which to list resources. A Multicloud base compartment is an OCI compartment that maps to a subscription in a cloud service provider (such as Azure or AWS).

  • 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

  • :subscription_id (String) —

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

  • :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.

  • :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.

  • :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

  • :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.

Returns:



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/multicloud/metadata_client.rb', line 254

def list_external_location_mapping_metadata(subscription_service_name, compartment_id, opts = {})
  logger.debug 'Calling operation MetadataClient#list_external_location_mapping_metadata.' if logger

  raise "Missing the required parameter 'subscription_service_name' when calling list_external_location_mapping_metadata." if subscription_service_name.nil?

  subscription_service_name_allowable_values = %w[ORACLEDBATAZURE ORACLEDBATGOOGLE ORACLEDBATAWS]
  subscription_service_name.each do |val_to_check|
    unless subscription_service_name_allowable_values.include?(val_to_check)
      raise "Invalid value for 'subscription_service_name', must be one of ORACLEDBATAZURE, ORACLEDBATGOOGLE, ORACLEDBATAWS."
    end
  end
  raise "Missing the required parameter 'compartment_id' when calling list_external_location_mapping_metadata." if compartment_id.nil?

  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

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

  path = '/externalLocationMappingMetadata'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:subscriptionServiceName] = OCI::ApiClient.build_collection_params(subscription_service_name, :multi)
  query_params[:compartmentId] = compartment_id
  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[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'MetadataClient#list_external_location_mapping_metadata') 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::ExternalLocationMappingMetadatumSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_external_location_summaries_metadata(subscription_service_name, compartment_id, opts = {}) ⇒ Response

Note:

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

List externalLocationSummary metadata from OCI Region to the Cloud Service Provider region across all regions.

Parameters:

  • subscription_service_name (String) —

    The cloud service provider.

  • compartment_id (String) —

    The OCID of the Multicloud base compartment in which to list resources. A Multicloud base compartment is an OCI compartment that maps to a subscription in a cloud service provider (such as Azure or AWS).

  • 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

  • :subscription_id (String) —

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

  • :entity_type (String) —

    The resource type query (for example, dbsystem or instance). Allowed values are: dbsystem

  • :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.

  • :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.

  • :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

  • :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.

Returns:



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/multicloud/metadata_client.rb', line 356

def list_external_location_summaries_metadata(subscription_service_name, compartment_id, opts = {})
  logger.debug 'Calling operation MetadataClient#list_external_location_summaries_metadata.' if logger

  raise "Missing the required parameter 'subscription_service_name' when calling list_external_location_summaries_metadata." if subscription_service_name.nil?
  unless OCI::Multicloud::Models::SUBSCRIPTION_TYPE_ENUM.include?(subscription_service_name)
    raise 'Invalid value for "subscription_service_name", must be one of the values in OCI::Multicloud::Models::SUBSCRIPTION_TYPE_ENUM.'
  end

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

  if opts[:entity_type] && !%w[dbsystem].include?(opts[:entity_type])
    raise 'Invalid value for "entity_type", must be one of dbsystem.'
  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

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

  path = '/externalLocationSummariesMetadata'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:subscriptionServiceName] = subscription_service_name
  query_params[:compartmentId] = compartment_id
  query_params[:subscriptionId] = opts[:subscription_id] if opts[:subscription_id]
  query_params[:entityType] = opts[:entity_type] if opts[:entity_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'MetadataClient#list_external_location_summaries_metadata') 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::ExternalLocationSummariesMetadatumSummaryCollection'
    )
  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/metadata_client.rb', line 94

def logger
  @api_client.config.logger
end