Class: OCI::ServiceManagerProxy::ServiceManagerProxyClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/service_manager_proxy/service_manager_proxy_client.rb

Overview

Use the Service Manager Proxy API to obtain information about SaaS environments provisioned by Service Manager. You can get information such as service types and service environment URLs.

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) ⇒ ServiceManagerProxyClient

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



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

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



16
17
18
 
# File 'lib/oci/service_manager_proxy/service_manager_proxy_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/service_manager_proxy/service_manager_proxy_client.rb', line 20

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/service_manager_proxy/service_manager_proxy_client.rb', line 30

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:



26
27
28
 
# File 'lib/oci/service_manager_proxy/service_manager_proxy_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#get_service_environment(service_environment_id, compartment_id, opts = {}) ⇒ Response

Note:

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

Get the detailed information for a specific service environment.

Parameters:

  • service_environment_id (String) —

    The unique identifier associated with the service environment.

    Note: Not an OCID.

  • compartment_id (String) —

    The OCID for the compartment.

  • 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

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

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/service_manager_proxy/service_manager_proxy_client.rb', line 119

def get_service_environment(service_environment_id, compartment_id, opts = {})
  logger.debug 'Calling operation ServiceManagerProxyClient#get_service_environment.' if logger

  raise "Missing the required parameter 'service_environment_id' when calling get_service_environment." if service_environment_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling get_service_environment." if compartment_id.nil?
  raise "Parameter value for 'service_environment_id' must not be blank" if OCI::Internal::Util.blank_string?(service_environment_id)

  path = '/serviceEnvironments/{serviceEnvironmentId}'.sub('{serviceEnvironmentId}', service_environment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

  # 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: 'ServiceManagerProxyClient#get_service_environment') 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::ServiceManagerProxy::Models::ServiceEnvironment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List the details of Software as a Service (SaaS) environments provisioned by Service Manager. Information includes the service instance endpoints and service definition details.

Allowed values are: ID

Parameters:

  • compartment_id (String) —

    The OCID for the compartment.

  • 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

  • :service_environment_id (String) —

    The unique identifier associated with the service environment.

    Note: Not an OCID.

  • :service_environment_type (String) —

    The environment's service definition type. For example, "RGBUOROMS" is the service definition type for "Oracle Retail Order Management Cloud Service".

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

  • :limit (Integer) —

    How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. (default to 30)

  • :page (String) —

    The value of the opc-next-page response header from the previous "List" call.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. ID is default ordered as ascending. (default to ID)

  • :sort_order (String) —

    The sort order to use, either ASC or DESC. (default to DESC) Allowed values are: ASC, DESC

  • :display_name (String) —

    The display name of the resource.

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/service_manager_proxy/service_manager_proxy_client.rb', line 195

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

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

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

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

  path = '/serviceEnvironments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:serviceEnvironmentId] = opts[:service_environment_id] if opts[:service_environment_id]
  query_params[:serviceEnvironmentType] = opts[:service_environment_type] if opts[:service_environment_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'ServiceManagerProxyClient#list_service_environments') 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::ServiceManagerProxy::Models::ServiceEnvironmentCollection'
    )
  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.



95
96
97
 
# File 'lib/oci/service_manager_proxy/service_manager_proxy_client.rb', line 95

def logger
  @api_client.config.logger
end