Class: OCI::ResourceSearch::ResourceSearchClient
- Inherits:
-
Object
- Object
- OCI::ResourceSearch::ResourceSearchClient
- Defined in:
- lib/oci/resource_search/resource_search_client.rb
Overview
Search for resources in your cloud network.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in OCI::Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#get_resource_type(name, opts = {}) ⇒ Response
Gets detailed information about a resource type by using the resource type name.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ResourceSearchClient
constructor
Creates a new ResourceSearchClient.
-
#list_resource_types(opts = {}) ⇒ Response
Lists all resource types that you can search or query for.
-
#logger ⇒ Logger
The logger for this client.
-
#search_resources(search_details, opts = {}) ⇒ Response
Queries any and all compartments in the specified tenancy to find resources that match the specified criteria.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ResourceSearchClient
Creates a new ResourceSearchClient. 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.
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/resource_search/resource_search_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 + '/20180409' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "ResourceSearchClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/resource_search/resource_search_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/resource_search/resource_search_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in OCI::Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/resource_search/resource_search_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
25 26 27 |
# File 'lib/oci/resource_search/resource_search_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#get_resource_type(name, opts = {}) ⇒ Response
Click here to see an example of how to use get_resource_type API.
Gets detailed information about a resource type by using the resource type name.
114 115 116 117 118 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 |
# File 'lib/oci/resource_search/resource_search_client.rb', line 114 def get_resource_type(name, opts = {}) logger.debug 'Calling operation ResourceSearchClient#get_resource_type.' if logger raise "Missing the required parameter 'name' when calling get_resource_type." if name.nil? raise "Parameter value for 'name' must not be blank" if OCI::Internal::Util.blank_string?(name) path = '/resourceTypes/{name}'.sub('{name}', name.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.(applicable_retry_config(opts), call_name: 'ResourceSearchClient#get_resource_type') 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::ResourceSearch::Models::ResourceType' ) end # rubocop:enable Metrics/BlockLength end |
#list_resource_types(opts = {}) ⇒ Response
Click here to see an example of how to use list_resource_types API.
Lists all resource types that you can search or query for.
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 |
# File 'lib/oci/resource_search/resource_search_client.rb', line 172 def list_resource_types(opts = {}) logger.debug 'Calling operation ResourceSearchClient#list_resource_types.' if logger path = '/resourceTypes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} 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.(applicable_retry_config(opts), call_name: 'ResourceSearchClient#list_resource_types') 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::ResourceSearch::Models::ResourceType>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/resource_search/resource_search_client.rb', line 94 def logger @api_client.config.logger end |
#search_resources(search_details, opts = {}) ⇒ Response
Click here to see an example of how to use search_resources API.
Queries any and all compartments in the specified tenancy to find resources that match the specified criteria. Results include resources that you have permission to view and can span different resource types. You can also sort results based on a specified resource attribute.
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/oci/resource_search/resource_search_client.rb', line 236 def search_resources(search_details, opts = {}) logger.debug 'Calling operation ResourceSearchClient#search_resources.' if logger raise "Missing the required parameter 'search_details' when calling search_resources." if search_details.nil? path = '/resources' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:tenantId] = opts[:tenant_id] if opts[:tenant_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 = @api_client.object_to_http_body(search_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ResourceSearchClient#search_resources') 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::ResourceSearch::Models::ResourceSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |