Class: OCI::GenericArtifactsContent::GenericArtifactsContentClient
- Inherits:
-
Object
- Object
- OCI::GenericArtifactsContent::GenericArtifactsContentClient
- Defined in:
- lib/oci/generic_artifacts_content/generic_artifacts_content_client.rb
Overview
API covering the Generic Artifacts Service content Use this API to put and get generic artifact content.
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 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_generic_artifact_content(artifact_id, opts = {}, &block) ⇒ Response
Gets the specified artifact's content.
-
#get_generic_artifact_content_by_path(repository_id, artifact_path, version, opts = {}, &block) ⇒ Response
Gets the content of an artifact with a specified
artifactPath
andversion
. -
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ GenericArtifactsContentClient
constructor
Creates a new GenericArtifactsContentClient.
-
#logger ⇒ Logger
The logger for this client.
-
#put_generic_artifact_content_by_path(repository_id, artifact_path, version, generic_artifact_content_body, opts = {}) ⇒ Response
Uploads an artifact.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ GenericArtifactsContentClient
Creates a new GenericArtifactsContentClient. 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.
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/generic_artifacts_content/generic_artifacts_content_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 + '/20160918' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "GenericArtifactsContentClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
16 17 18 |
# File 'lib/oci/generic_artifacts_content/generic_artifacts_content_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/generic_artifacts_content/generic_artifacts_content_client.rb', line 20 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
30 31 32 |
# File 'lib/oci/generic_artifacts_content/generic_artifacts_content_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
26 27 28 |
# File 'lib/oci/generic_artifacts_content/generic_artifacts_content_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#get_generic_artifact_content(artifact_id, opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_generic_artifact_content API.
Gets the specified artifact's content.
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 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 |
# File 'lib/oci/generic_artifacts_content/generic_artifacts_content_client.rb', line 121 def get_generic_artifact_content(artifact_id, opts = {}, &block) logger.debug 'Calling operation GenericArtifactsContentClient#get_generic_artifact_content.' if logger raise "Missing the required parameter 'artifact_id' when calling get_generic_artifact_content." if artifact_id.nil? raise "Parameter value for 'artifact_id' must not be blank" if OCI::Internal::Util.blank_string?(artifact_id) path = '/generic/artifacts/{artifactId}/content'.sub('{artifactId}', artifact_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'application/octet-stream' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] 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: 'GenericArtifactsContentClient#get_generic_artifact_content') do if !block.nil? @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: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @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: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @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: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @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: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#get_generic_artifact_content_by_path(repository_id, artifact_path, version, opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_generic_artifact_content_by_path API.
Gets the content of an artifact with a specified artifactPath
and version
.
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 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 313 314 315 316 317 318 319 320 |
# File 'lib/oci/generic_artifacts_content/generic_artifacts_content_client.rb', line 236 def get_generic_artifact_content_by_path(repository_id, artifact_path, version, opts = {}, &block) logger.debug 'Calling operation GenericArtifactsContentClient#get_generic_artifact_content_by_path.' if logger raise "Missing the required parameter 'repository_id' when calling get_generic_artifact_content_by_path." if repository_id.nil? raise "Missing the required parameter 'artifact_path' when calling get_generic_artifact_content_by_path." if artifact_path.nil? raise "Missing the required parameter 'version' when calling get_generic_artifact_content_by_path." if version.nil? raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id) raise "Parameter value for 'artifact_path' must not be blank" if OCI::Internal::Util.blank_string?(artifact_path) raise "Parameter value for 'version' must not be blank" if OCI::Internal::Util.blank_string?(version) path = '/generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}/content'.sub('{repositoryId}', repository_id.to_s).sub('{artifactPath}', artifact_path.to_s).sub('{version}', version.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'application/octet-stream' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] 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: 'GenericArtifactsContentClient#get_generic_artifact_content_by_path') do if !block.nil? @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: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @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: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @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: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @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: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/generic_artifacts_content/generic_artifacts_content_client.rb', line 95 def logger @api_client.config.logger end |
#put_generic_artifact_content_by_path(repository_id, artifact_path, version, generic_artifact_content_body, opts = {}) ⇒ Response
Click here to see an example of how to use put_generic_artifact_content_by_path API.
Uploads an artifact. Provide artifactPath
, version
and content. Avoid entering confidential information when you define the path and version.
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 |
# File 'lib/oci/generic_artifacts_content/generic_artifacts_content_client.rb', line 356 def put_generic_artifact_content_by_path(repository_id, artifact_path, version, generic_artifact_content_body, opts = {}) logger.debug 'Calling operation GenericArtifactsContentClient#put_generic_artifact_content_by_path.' if logger raise "Missing the required parameter 'repository_id' when calling put_generic_artifact_content_by_path." if repository_id.nil? raise "Missing the required parameter 'artifact_path' when calling put_generic_artifact_content_by_path." if artifact_path.nil? raise "Missing the required parameter 'version' when calling put_generic_artifact_content_by_path." if version.nil? raise "Missing the required parameter 'generic_artifact_content_body' when calling put_generic_artifact_content_by_path." if generic_artifact_content_body.nil? raise "Parameter value for 'repository_id' must not be blank" if OCI::Internal::Util.blank_string?(repository_id) raise "Parameter value for 'artifact_path' must not be blank" if OCI::Internal::Util.blank_string?(artifact_path) raise "Parameter value for 'version' must not be blank" if OCI::Internal::Util.blank_string?(version) path = '/generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}/content'.sub('{repositoryId}', repository_id.to_s).sub('{artifactPath}', artifact_path.to_s).sub('{version}', version.to_s) operation_signing_strategy = :exclude_body # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'content-type'] ||= 'application/octet-stream' post_body = @api_client.object_to_http_body(generic_artifact_content_body) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'GenericArtifactsContentClient#put_generic_artifact_content_by_path') 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::GenericArtifactsContent::Models::GenericArtifact' ) end # rubocop:enable Metrics/BlockLength end |