Class: OCI::Marketplace::MarketplaceClient

#change_publication_compartment(publication_id, change_publication_compartment_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/change_publication_compartment.rb.html) to see an example of how to use change_publication_compartment API.

Moves the specified publication from one compartment to another.

Parameters:

publication_id (String) —

The unique identifier for the publication.
change_publication_compartment_details (OCI::Marketplace::Models::ChangePublicationCompartmentDetails) —

The details of the request to change the compartment of a given publication.
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_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected).
: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.
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/marketplace/marketplace_client.rb', line 121

def change_publication_compartment(publication_id, change_publication_compartment_details, opts = {})
  logger.debug 'Calling operation MarketplaceClient#change_publication_compartment.' if logger

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

  path = '/publications/{publicationId}/actions/changeCompartment'.sub('{publicationId}', publication_id.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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_publication_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#change_publication_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_accepted_agreement(create_accepted_agreement_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/create_accepted_agreement.rb.html) to see an example of how to use create_accepted_agreement API.

Accepts a terms of use agreement for a specific package version of a listing. You must accept all terms of use for a package before you can deploy the package.

Parameters:

create_accepted_agreement_details (OCI::Marketplace::Models::CreateAcceptedAgreementDetails) —

Details necessary to accept an agreement.
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.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected).

Returns:

(Response) —

A Response object with data of type AcceptedAgreement

# File 'lib/oci/marketplace/marketplace_client.rb', line 187

def create_accepted_agreement(create_accepted_agreement_details, opts = {})
  logger.debug 'Calling operation MarketplaceClient#create_accepted_agreement.' if logger

  raise "Missing the required parameter 'create_accepted_agreement_details' when calling create_accepted_agreement." if create_accepted_agreement_details.nil?

  path = '/acceptedAgreements'
  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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_accepted_agreement_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#create_accepted_agreement') 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::Marketplace::Models::AcceptedAgreement'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_publication(create_publication_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/create_publication.rb.html) to see an example of how to use create_publication API.

Creates a publication of the specified listing type with an optional default package.

Parameters:

create_publication_details (OCI::Marketplace::Models::CreatePublicationDetails) —

The details for creating the publication.
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_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected).
: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:

(Response) —

A Response object with data of type Publication

# File 'lib/oci/marketplace/marketplace_client.rb', line 249

def create_publication(create_publication_details, opts = {})
  logger.debug 'Calling operation MarketplaceClient#create_publication.' if logger

  raise "Missing the required parameter 'create_publication_details' when calling create_publication." if create_publication_details.nil?

  path = '/publications'
  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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_publication_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#create_publication') 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::Marketplace::Models::Publication'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_accepted_agreement(accepted_agreement_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/delete_accepted_agreement.rb.html) to see an example of how to use delete_accepted_agreement API.

Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks before initiating a deployment. Listings in Marketplace that require acceptance of the specified terms of use can no longer be deployed, but existing deployments aren't affected.

Parameters:

accepted_agreement_id (String) —

The unique identifier for the accepted terms of use agreement.
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
:signature (String) —

Previously, the signature generated for the listing package terms of use agreement, but now deprecated and ignored.
: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.
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/marketplace/marketplace_client.rb', line 314

def delete_accepted_agreement(accepted_agreement_id, opts = {})
  logger.debug 'Calling operation MarketplaceClient#delete_accepted_agreement.' if logger

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

  path = '/acceptedAgreements/{acceptedAgreementId}'.sub('{acceptedAgreementId}', accepted_agreement_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:signature] = opts[:signature] if opts[:signature]

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#delete_accepted_agreement') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_publication(publication_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/delete_publication.rb.html) to see an example of how to use delete_publication API.

Deletes a publication, which also removes the associated listing from anywhere it was published, such as Marketplace or Compute.

Parameters:

publication_id (String) —

The unique identifier for the publication.
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
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
: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:

(Response) —

A Response object with data of type nil

# File 'lib/oci/marketplace/marketplace_client.rb', line 375

def delete_publication(publication_id, opts = {})
  logger.debug 'Calling operation MarketplaceClient#delete_publication.' if logger

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

  path = '/publications/{publicationId}'.sub('{publicationId}', publication_id.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[:'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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#delete_publication') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_accepted_agreement(accepted_agreement_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/get_accepted_agreement.rb.html) to see an example of how to use get_accepted_agreement API.

Gets the details of a specific, previously accepted terms of use agreement.

Parameters:

accepted_agreement_id (String) —

The unique identifier for the accepted terms of use agreement.
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:

(Response) —

A Response object with data of type AcceptedAgreement

# File 'lib/oci/marketplace/marketplace_client.rb', line 432

def get_accepted_agreement(accepted_agreement_id, opts = {})
  logger.debug 'Calling operation MarketplaceClient#get_accepted_agreement.' if logger

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

  path = '/acceptedAgreements/{acceptedAgreementId}'.sub('{acceptedAgreementId}', accepted_agreement_id.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.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#get_accepted_agreement') 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::Marketplace::Models::AcceptedAgreement'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_agreement(listing_id, package_version, agreement_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/get_agreement.rb.html) to see an example of how to use get_agreement API.

Returns a terms of use agreement for a package with a time-based signature that can be used to accept the agreement.

Parameters:

listing_id (String) —

The unique identifier for the listing.
package_version (String) —

The version of the package. Package versions are unique within a listing.
agreement_id (String) —

The unique identifier for the agreement.
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.
:compartment_id (String) —

The unique identifier for the compartment.

Returns:

(Response) —

A Response object with data of type Agreement

# File 'lib/oci/marketplace/marketplace_client.rb', line 493

def get_agreement(listing_id, package_version, agreement_id, opts = {})
  logger.debug 'Calling operation MarketplaceClient#get_agreement.' if logger

  raise "Missing the required parameter 'listing_id' when calling get_agreement." if listing_id.nil?
  raise "Missing the required parameter 'package_version' when calling get_agreement." if package_version.nil?
  raise "Missing the required parameter 'agreement_id' when calling get_agreement." if agreement_id.nil?
  raise "Parameter value for 'listing_id' must not be blank" if OCI::Internal::Util.blank_string?(listing_id)
  raise "Parameter value for 'package_version' must not be blank" if OCI::Internal::Util.blank_string?(package_version)
  raise "Parameter value for 'agreement_id' must not be blank" if OCI::Internal::Util.blank_string?(agreement_id)

  path = '/listings/{listingId}/packages/{packageVersion}/agreements/{agreementId}'.sub('{listingId}', listing_id.to_s).sub('{packageVersion}', package_version.to_s).sub('{agreementId}', agreement_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[: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: 'MarketplaceClient#get_agreement') 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::Marketplace::Models::Agreement'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_listing(listing_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/get_listing.rb.html) to see an example of how to use get_listing API.

Gets detailed information about a listing, including the listing's name, version, description, and resources.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

Parameters:

listing_id (String) —

The unique identifier for the listing.
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.
:compartment_id (String) —

The unique identifier for the compartment.

Returns:

(Response) —

A Response object with data of type Listing

# File 'lib/oci/marketplace/marketplace_client.rb', line 570

def get_listing(listing_id, opts = {})
  logger.debug 'Calling operation MarketplaceClient#get_listing.' if logger

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

  path = '/listings/{listingId}'.sub('{listingId}', listing_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[: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: 'MarketplaceClient#get_listing') 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::Marketplace::Models::Listing'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_package(listing_id, package_version, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/get_package.rb.html) to see an example of how to use get_package API.

Get the details of the specified version of a package, including information needed to launch the package.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

Parameters:

listing_id (String) —

The unique identifier for the listing.
package_version (String) —

The version of the package. Package versions are unique within a listing.
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.
:compartment_id (String) —

The unique identifier for the compartment.

Returns:

(Response) —

A Response object with data of type ListingPackage

# File 'lib/oci/marketplace/marketplace_client.rb', line 643

def get_package(listing_id, package_version, opts = {})
  logger.debug 'Calling operation MarketplaceClient#get_package.' if logger

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

  path = '/listings/{listingId}/packages/{packageVersion}'.sub('{listingId}', listing_id.to_s).sub('{packageVersion}', package_version.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[: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: 'MarketplaceClient#get_package') 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::Marketplace::Models::ListingPackage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_publication(publication_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/get_publication.rb.html) to see an example of how to use get_publication API.

Gets the details of the specified publication.

Parameters:

publication_id (String) —

The unique identifier for the publication.
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:

(Response) —

A Response object with data of type Publication

# File 'lib/oci/marketplace/marketplace_client.rb', line 702

def get_publication(publication_id, opts = {})
  logger.debug 'Calling operation MarketplaceClient#get_publication.' if logger

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

  path = '/publications/{publicationId}'.sub('{publicationId}', publication_id.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.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#get_publication') 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::Marketplace::Models::Publication'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_publication_package(publication_id, package_version, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/get_publication_package.rb.html) to see an example of how to use get_publication_package API.

Gets the details of a specific package version within a given publication.

Parameters:

publication_id (String) —

The unique identifier for the publication.
package_version (String) —

The version of the package. Package versions are unique within a listing.
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:

(Response) —

A Response object with data of type PublicationPackage

# File 'lib/oci/marketplace/marketplace_client.rb', line 759

def get_publication_package(publication_id, package_version, opts = {})
  logger.debug 'Calling operation MarketplaceClient#get_publication_package.' if logger

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

  path = '/publications/{publicationId}/packages/{packageVersion}'.sub('{publicationId}', publication_id.to_s).sub('{packageVersion}', package_version.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.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#get_publication_package') 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::Marketplace::Models::PublicationPackage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_accepted_agreements(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_accepted_agreements.rb.html) to see an example of how to use list_accepted_agreements API.

Lists the terms of use agreements that have been accepted in the specified compartment. You can filter results by specifying query parameters.

Parameters:

compartment_id (String) —

The unique identifier 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
:display_name (String) —

The display name of the resource.
:listing_id (String) —

The unique identifier for the listing.
:package_version (String) —

The version of the package. Package versions are unique within a listing.
:accepted_agreement_id (String) —

The unique identifier for the accepted terms of use agreement.
: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.
:sort_by (String) —
The field to use to sort listed results. You can only specify one field to sort by. `TIMEACCEPTED` displays results in descending order by default. You can change your preference by specifying a different sort order.
```
(default to TIMEACCEPTED)
```
Allowed values are: TIMEACCEPTED
:sort_order (String) —

The sort order to use, either `ASC` or `DESC`. (default to ASC) Allowed values are: ASC, DESC
: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.

Returns:

(Response) —

A Response object with data of type Array<AcceptedAgreementSummary>

# File 'lib/oci/marketplace/marketplace_client.rb', line 833

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

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

  if opts[:sort_by] && !%w[TIMEACCEPTED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMEACCEPTED.'
  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 = '/acceptedAgreements'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:listingId] = opts[:listing_id] if opts[:listing_id]
  query_params[:packageVersion] = opts[:package_version] if opts[:package_version]
  query_params[:acceptedAgreementId] = opts[:accepted_agreement_id] if opts[:accepted_agreement_id]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#list_accepted_agreements') 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::Marketplace::Models::AcceptedAgreementSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_agreements(listing_id, package_version, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_agreements.rb.html) to see an example of how to use list_agreements API.

Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.

Parameters:

listing_id (String) —

The unique identifier for the listing.
package_version (String) —

The version of the package. Package versions are unique within a listing.
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.
: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.
:compartment_id (String) —

The unique identifier for the compartment.

Returns:

(Response) —

A Response object with data of type Array<AgreementSummary>

# File 'lib/oci/marketplace/marketplace_client.rb', line 911

def list_agreements(listing_id, package_version, opts = {})
  logger.debug 'Calling operation MarketplaceClient#list_agreements.' if logger

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

  path = '/listings/{listingId}/packages/{packageVersion}/agreements'.sub('{listingId}', listing_id.to_s).sub('{packageVersion}', package_version.to_s)
  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[:compartmentId] = opts[:compartment_id] if opts[: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: 'MarketplaceClient#list_agreements') 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::Marketplace::Models::AgreementSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_categories.rb.html) to see an example of how to use list_categories API.

Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace. Categories apply to the software product provided by the listing.

Parameters:

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.
: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.
:compartment_id (String) —

The unique identifier for the compartment.

Returns:

(Response) —

A Response object with data of type Array<CategorySummary>

# File 'lib/oci/marketplace/marketplace_client.rb', line 977

def list_categories(opts = {})
  logger.debug 'Calling operation MarketplaceClient#list_categories.' if logger


  path = '/categories'
  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[:compartmentId] = opts[:compartment_id] if opts[: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: 'MarketplaceClient#list_categories') 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::Marketplace::Models::CategorySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_listings(opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_listings.rb.html) to see an example of how to use list_listings API.

Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and filtering according to listing attributes.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

Parameters:

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
:name (Array<String>) —

The name of the listing.
:listing_id (String) —

The unique identifier for the listing.
:image_id (String) —

The image identifier of the listing.
:publisher_id (String) —

Limit results to just this publisher.
:package_type (String) —

A filter to return only packages that match the given package type exactly.
: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 use to sort listed results. You can only specify one field to sort by. `TIMERELEASED` displays results in descending order by default. You can change your preference by specifying a different sort order.
```
(default to TIMERELEASED)
```
Allowed values are: TIMERELEASED
:sort_order (String) —

The sort order to use, either `ASC` or `DESC`. (default to DESC) Allowed values are: ASC, DESC
:category (Array<String>) —

Name of the product category or categories. If you specify multiple categories, then Marketplace returns any listing with one or more matching categories.
:pricing (Array<String>) —

Name of the pricing type. If multiple pricing types are provided, then any listing with one or more matching pricing models will be returned.

Allowed values are: FREE, BYOL, PAYGO
:is_featured (BOOLEAN) —

Indicates whether to show only featured listings. If this is set to `false` or is omitted, then all listings will be returned. (default to false)
:listing_types (Array<String>) —

The type of the listing. Allowed values are: COMMUNITY, PARTNER, PRIVATE
:operating_systems (Array<String>) —

The operating system of the listing.
:compartment_id (String) —

The unique identifier for the compartment.

Returns:

(Response) —

A Response object with data of type Array<ListingSummary>

# File 'lib/oci/marketplace/marketplace_client.rb', line 1077

def list_listings(opts = {})
  logger.debug 'Calling operation MarketplaceClient#list_listings.' if logger


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


  pricing_allowable_values = %w[FREE BYOL PAYGO]
  if opts[:pricing] && !opts[:pricing].empty?
    opts[:pricing].each do |val_to_check|
      unless pricing_allowable_values.include?(val_to_check)
        raise 'Invalid value for "pricing", must be one of FREE, BYOL, PAYGO.'
      end
    end
  end


  listing_types_allowable_values = %w[COMMUNITY PARTNER PRIVATE]
  if opts[:listing_types] && !opts[:listing_types].empty?
    opts[:listing_types].each do |val_to_check|
      unless listing_types_allowable_values.include?(val_to_check)
        raise 'Invalid value for "listing_types", must be one of COMMUNITY, PARTNER, PRIVATE.'
      end
    end
  end

  path = '/listings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty?
  query_params[:listingId] = opts[:listing_id] if opts[:listing_id]
  query_params[:imageId] = opts[:image_id] if opts[:image_id]
  query_params[:publisherId] = opts[:publisher_id] if opts[:publisher_id]
  query_params[:packageType] = opts[:package_type] if opts[:package_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[:category] = OCI::ApiClient.build_collection_params(opts[:category], :multi) if opts[:category] && !opts[:category].empty?
  query_params[:pricing] = OCI::ApiClient.build_collection_params(opts[:pricing], :multi) if opts[:pricing] && !opts[:pricing].empty?
  query_params[:isFeatured] = opts[:is_featured] if !opts[:is_featured].nil?
  query_params[:listingTypes] = OCI::ApiClient.build_collection_params(opts[:listing_types], :multi) if opts[:listing_types] && !opts[:listing_types].empty?
  query_params[:operatingSystems] = OCI::ApiClient.build_collection_params(opts[:operating_systems], :multi) if opts[:operating_systems] && !opts[:operating_systems].empty?
  query_params[:compartmentId] = opts[:compartment_id] if opts[: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: 'MarketplaceClient#list_listings') 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::Marketplace::Models::ListingSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_packages(listing_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_packages.rb.html) to see an example of how to use list_packages API.

Gets the list of packages for a listing.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

Parameters:

listing_id (String) —

The unique identifier for the listing.
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
:package_version (String) —

The version of the package. Package versions are unique within a listing.
:package_type (String) —

A filter to return only packages that match the given package type exactly.
: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 use to sort listed results. You can only specify one field to sort by. `TIMERELEASED` displays results in descending order by default. You can change your preference by specifying a different sort order.
```
(default to TIMERELEASED)
```
Allowed values are: TIMERELEASED
:sort_order (String) —

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

The unique identifier for the compartment.

Returns:

(Response) —

A Response object with data of type Array<ListingPackageSummary>

# File 'lib/oci/marketplace/marketplace_client.rb', line 1202

def list_packages(listing_id, opts = {})
  logger.debug 'Calling operation MarketplaceClient#list_packages.' if logger

  raise "Missing the required parameter 'listing_id' when calling list_packages." if listing_id.nil?

  if opts[:sort_by] && !%w[TIMERELEASED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMERELEASED.'
  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
  raise "Parameter value for 'listing_id' must not be blank" if OCI::Internal::Util.blank_string?(listing_id)

  path = '/listings/{listingId}/packages'.sub('{listingId}', listing_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:packageVersion] = opts[:package_version] if opts[:package_version]
  query_params[:packageType] = opts[:package_type] if opts[:package_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[:compartmentId] = opts[:compartment_id] if opts[: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: 'MarketplaceClient#list_packages') 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::Marketplace::Models::ListingPackageSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_publication_packages(publication_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_publication_packages.rb.html) to see an example of how to use list_publication_packages API.

Lists the packages in the specified publication.

Parameters:

publication_id (String) —

The unique identifier for the publication.
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
:package_version (String) —

The version of the package. Package versions are unique within a listing.
:package_type (String) —

A filter to return only packages that match the given package type exactly.
:sort_by (String) —
The field to use to sort listed results. You can only specify one field to sort by. `TIMERELEASED` displays results in descending order by default. You can change your preference by specifying a different sort order.
```
(default to TIMERELEASED)
```
Allowed values are: TIMERELEASED
:sort_order (String) —

The sort order to use, either `ASC` or `DESC`. (default to DESC) Allowed values are: ASC, DESC
: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.
: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:

(Response) —

A Response object with data of type Array<PublicationPackageSummary>

# File 'lib/oci/marketplace/marketplace_client.rb', line 1286

def list_publication_packages(publication_id, opts = {})
  logger.debug 'Calling operation MarketplaceClient#list_publication_packages.' if logger

  raise "Missing the required parameter 'publication_id' when calling list_publication_packages." if publication_id.nil?

  if opts[:sort_by] && !%w[TIMERELEASED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMERELEASED.'
  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
  raise "Parameter value for 'publication_id' must not be blank" if OCI::Internal::Util.blank_string?(publication_id)

  path = '/publications/{publicationId}/packages'.sub('{publicationId}', publication_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:packageVersion] = opts[:package_version] if opts[:package_version]
  query_params[:packageType] = opts[:package_type] if opts[:package_type]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#list_publication_packages') 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::Marketplace::Models::PublicationPackageSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_publications(compartment_id, listing_type, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_publications.rb.html) to see an example of how to use list_publications API.

Lists the publications in the specified compartment.

Parameters:

compartment_id (String) —

The unique identifier for the compartment.
listing_type (String) —

The type of the listing.
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
:name (Array<String>) —

The name of the publication.
:publication_id (String) —

The unique identifier for the publication.
:operating_systems (Array<String>) —

The operating system of the listing.
:sort_by (String) —
The field to use to sort listed results. You can only specify one field to sort by. `TIMERELEASED` displays results in descending order by default. You can change your preference by specifying a different sort order.
```
(default to TIMERELEASED)
```
Allowed values are: TIMERELEASED
:sort_order (String) —

The sort order to use, either `ASC` or `DESC`. (default to DESC) Allowed values are: ASC, DESC
: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.
: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:

(Response) —

A Response object with data of type Array<PublicationSummary>

# File 'lib/oci/marketplace/marketplace_client.rb', line 1370

def list_publications(compartment_id, listing_type, opts = {})
  logger.debug 'Calling operation MarketplaceClient#list_publications.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_publications." if compartment_id.nil?
  raise "Missing the required parameter 'listing_type' when calling list_publications." if listing_type.nil?
  unless OCI::Marketplace::Models::LISTING_TYPE_ENUM.include?(listing_type)
    raise 'Invalid value for "listing_type", must be one of the values in OCI::Marketplace::Models::LISTING_TYPE_ENUM.'
  end


  if opts[:sort_by] && !%w[TIMERELEASED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMERELEASED.'
  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 = '/publications'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:listingType] = listing_type
  query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty?
  query_params[:publicationId] = opts[:publication_id] if opts[:publication_id]
  query_params[:operatingSystems] = OCI::ApiClient.build_collection_params(opts[:operating_systems], :multi) if opts[:operating_systems] && !opts[:operating_systems].empty?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#list_publications') 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::Marketplace::Models::PublicationSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_publishers(opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_publishers.rb.html) to see an example of how to use list_publishers API.

Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.

Parameters:

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
:publisher_id (String) —

Limit results to just this publisher.
: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.
:compartment_id (String) —

The unique identifier for the compartment.

Returns:

(Response) —

A Response object with data of type Array<PublisherSummary>

# File 'lib/oci/marketplace/marketplace_client.rb', line 1452

def list_publishers(opts = {})
  logger.debug 'Calling operation MarketplaceClient#list_publishers.' if logger


  path = '/publishers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:publisherId] = opts[:publisher_id] if opts[:publisher_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:compartmentId] = opts[:compartment_id] if opts[: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: 'MarketplaceClient#list_publishers') 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::Marketplace::Models::PublisherSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_report_types(compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_report_types.rb.html) to see an example of how to use list_report_types API.

Lists available types of reports for the compartment.

Parameters:

compartment_id (String) —

The unique identifier 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.
:page (String) —

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

Returns:

(Response) —

A Response object with data of type ReportTypeCollection

# File 'lib/oci/marketplace/marketplace_client.rb', line 1511

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

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

  path = '/reportTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#list_report_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: 'OCI::Marketplace::Models::ReportTypeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_reports(report_type, date, compartment_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_reports.rb.html) to see an example of how to use list_reports API.

Lists reports in the compartment that match the specified report type and date.

Parameters:

report_type (String) —

The type of the report.
date (DateTime) —

Date, expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format. The service only interprets the year, month, and day parts in the input value, and ignores the hour, minute, and second parts.
compartment_id (String) —

The unique identifier 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.
:page (String) —

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

Returns:

(Response) —

A Response object with data of type ReportCollection

# File 'lib/oci/marketplace/marketplace_client.rb', line 1572

def list_reports(report_type, date, compartment_id, opts = {})
  logger.debug 'Calling operation MarketplaceClient#list_reports.' if logger

  raise "Missing the required parameter 'report_type' when calling list_reports." if report_type.nil?
  raise "Missing the required parameter 'date' when calling list_reports." if date.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_reports." if compartment_id.nil?

  path = '/reports'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:reportType] = report_type
  query_params[:date] = date
  query_params[:compartmentId] = compartment_id
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#list_reports') 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::Marketplace::Models::ReportCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_taxes(listing_id, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/list_taxes.rb.html) to see an example of how to use list_taxes API.

Returns list of all tax implications that current tenant may be liable to once they launch the listing.

Parameters:

listing_id (String) —

The unique identifier for the listing.
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.
:compartment_id (String) —

The unique identifier for the compartment.

Returns:

(Response) —

A Response object with data of type Array<TaxSummary>

# File 'lib/oci/marketplace/marketplace_client.rb', line 1634

def list_taxes(listing_id, opts = {})
  logger.debug 'Calling operation MarketplaceClient#list_taxes.' if logger

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

  path = '/listings/{listingId}/taxes'.sub('{listingId}', listing_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[: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: 'MarketplaceClient#list_taxes') 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::Marketplace::Models::TaxSummary>'
    )
  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.



92
93
94

# File 'lib/oci/marketplace/marketplace_client.rb', line 92

def logger
  @api_client.config.logger
end

#search_listings(search_listings_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/search_listings.rb.html) to see an example of how to use search_listings API.

Queries all Marketplace Applications to find listings that match the specified criteria. To search for a listing, you can use a free text or structured search.

Parameters:

search_listings_details (OCI::Marketplace::Models::SearchListingsDetails) —

Details related to the search query
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.
:page (String) —

The value of the `opc-next-page` response header from the previous "List" call.
: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)

Returns:

(Response) —

A Response object with data of type Array<ListingSummary>

# File 'lib/oci/marketplace/marketplace_client.rb', line 1696

def search_listings(search_listings_details, opts = {})
  logger.debug 'Calling operation MarketplaceClient#search_listings.' if logger

  raise "Missing the required parameter 'search_listings_details' when calling search_listings." if search_listings_details.nil?

  path = '/searchListings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # 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_listings_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#search_listings') 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: 'Array<OCI::Marketplace::Models::ListingSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_accepted_agreement(accepted_agreement_id, update_accepted_agreement_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/update_accepted_agreement.rb.html) to see an example of how to use update_accepted_agreement API.

Updates the display name or tags associated with a listing's previously accepted terms of use agreement.

Parameters:

accepted_agreement_id (String) —

The unique identifier for the accepted terms of use agreement.
update_accepted_agreement_details (OCI::Marketplace::Models::UpdateAcceptedAgreementDetails) —

Details to update for an accepted agreement.
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.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected).
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

(Response) —

A Response object with data of type AcceptedAgreement

# File 'lib/oci/marketplace/marketplace_client.rb', line 1764

def update_accepted_agreement(accepted_agreement_id, update_accepted_agreement_details, opts = {})
  logger.debug 'Calling operation MarketplaceClient#update_accepted_agreement.' if logger

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

  path = '/acceptedAgreements/{acceptedAgreementId}'.sub('{acceptedAgreementId}', accepted_agreement_id.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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_accepted_agreement_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#update_accepted_agreement') 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::Marketplace::Models::AcceptedAgreement'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_publication(publication_id, update_publication_details, opts = {}) ⇒ `Response`

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/marketplace/update_publication.rb.html) to see an example of how to use update_publication API.

Updates the details of an existing publication.

Parameters:

publication_id (String) —

The unique identifier for the publication.
update_publication_details (OCI::Marketplace::Models::UpdatePublicationDetails) —

The details for updating the publication.
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.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected).
:if_match (String) —

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

(Response) —

A Response object with data of type Publication

# File 'lib/oci/marketplace/marketplace_client.rb', line 1834

def update_publication(publication_id, update_publication_details, opts = {})
  logger.debug 'Calling operation MarketplaceClient#update_publication.' if logger

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

  path = '/publications/{publicationId}'.sub('{publicationId}', publication_id.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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_publication_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MarketplaceClient#update_publication') 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::Marketplace::Models::Publication'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

Overview

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) ⇒ `MarketplaceClient`

Instance Attribute Details

#api_client ⇒ `OCI::ApiClient` (readonly)

#endpoint ⇒ `String` (readonly)

#region ⇒ `String`

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

Instance Method Details

#change_publication_compartment(publication_id, change_publication_compartment_details, opts = {}) ⇒ `Response`

#create_accepted_agreement(create_accepted_agreement_details, opts = {}) ⇒ `Response`

#create_publication(create_publication_details, opts = {}) ⇒ `Response`

#delete_accepted_agreement(accepted_agreement_id, opts = {}) ⇒ `Response`

#delete_publication(publication_id, opts = {}) ⇒ `Response`

#get_accepted_agreement(accepted_agreement_id, opts = {}) ⇒ `Response`

#get_agreement(listing_id, package_version, agreement_id, opts = {}) ⇒ `Response`

#get_listing(listing_id, opts = {}) ⇒ `Response`

#get_package(listing_id, package_version, opts = {}) ⇒ `Response`

#get_publication(publication_id, opts = {}) ⇒ `Response`

#get_publication_package(publication_id, package_version, opts = {}) ⇒ `Response`

#list_accepted_agreements(compartment_id, opts = {}) ⇒ `Response`

#list_agreements(listing_id, package_version, opts = {}) ⇒ `Response`

#list_listings(opts = {}) ⇒ `Response`

#list_packages(listing_id, opts = {}) ⇒ `Response`

#list_publication_packages(publication_id, opts = {}) ⇒ `Response`

#list_publications(compartment_id, listing_type, opts = {}) ⇒ `Response`

#list_publishers(opts = {}) ⇒ `Response`

#list_report_types(compartment_id, opts = {}) ⇒ `Response`

#list_reports(report_type, date, compartment_id, opts = {}) ⇒ `Response`

#list_taxes(listing_id, opts = {}) ⇒ `Response`

#logger ⇒ `Logger`

#search_listings(search_listings_details, opts = {}) ⇒ `Response`

#update_accepted_agreement(accepted_agreement_id, update_accepted_agreement_details, opts = {}) ⇒ `Response`

#update_publication(publication_id, update_publication_details, opts = {}) ⇒ `Response`

Class: OCI::Marketplace::MarketplaceClient

Overview

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

#endpoint ⇒ String (readonly)

#region ⇒ String

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

Instance Method Details

#change_publication_compartment(publication_id, change_publication_compartment_details, opts = {}) ⇒ Response

#create_accepted_agreement(create_accepted_agreement_details, opts = {}) ⇒ Response

#create_publication(create_publication_details, opts = {}) ⇒ Response

#delete_accepted_agreement(accepted_agreement_id, opts = {}) ⇒ Response

#delete_publication(publication_id, opts = {}) ⇒ Response

#get_accepted_agreement(accepted_agreement_id, opts = {}) ⇒ Response

#get_agreement(listing_id, package_version, agreement_id, opts = {}) ⇒ Response

#get_listing(listing_id, opts = {}) ⇒ Response

#get_package(listing_id, package_version, opts = {}) ⇒ Response

#get_publication(publication_id, opts = {}) ⇒ Response

#get_publication_package(publication_id, package_version, opts = {}) ⇒ Response

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

#list_agreements(listing_id, package_version, opts = {}) ⇒ Response

#list_categories(opts = {}) ⇒ Response

#list_listings(opts = {}) ⇒ Response

#list_packages(listing_id, opts = {}) ⇒ Response

#list_publication_packages(publication_id, opts = {}) ⇒ Response

#list_publications(compartment_id, listing_type, opts = {}) ⇒ Response

#list_publishers(opts = {}) ⇒ Response

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

#list_reports(report_type, date, compartment_id, opts = {}) ⇒ Response

#list_taxes(listing_id, opts = {}) ⇒ Response

#logger ⇒ Logger

#search_listings(search_listings_details, opts = {}) ⇒ Response

#update_accepted_agreement(accepted_agreement_id, update_accepted_agreement_details, opts = {}) ⇒ Response

#update_publication(publication_id, update_publication_details, opts = {}) ⇒ Response

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

#api_client ⇒ `OCI::ApiClient` (readonly)

#endpoint ⇒ `String` (readonly)

#region ⇒ `String`

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

#change_publication_compartment(publication_id, change_publication_compartment_details, opts = {}) ⇒ `Response`

#create_accepted_agreement(create_accepted_agreement_details, opts = {}) ⇒ `Response`

#create_publication(create_publication_details, opts = {}) ⇒ `Response`

#delete_accepted_agreement(accepted_agreement_id, opts = {}) ⇒ `Response`

#delete_publication(publication_id, opts = {}) ⇒ `Response`

#get_accepted_agreement(accepted_agreement_id, opts = {}) ⇒ `Response`

#get_agreement(listing_id, package_version, agreement_id, opts = {}) ⇒ `Response`

#get_listing(listing_id, opts = {}) ⇒ `Response`

#get_package(listing_id, package_version, opts = {}) ⇒ `Response`

#get_publication(publication_id, opts = {}) ⇒ `Response`

#get_publication_package(publication_id, package_version, opts = {}) ⇒ `Response`

#list_accepted_agreements(compartment_id, opts = {}) ⇒ `Response`

#list_agreements(listing_id, package_version, opts = {}) ⇒ `Response`

#list_categories(opts = {}) ⇒ `Response`

#list_listings(opts = {}) ⇒ `Response`

#list_packages(listing_id, opts = {}) ⇒ `Response`

#list_publication_packages(publication_id, opts = {}) ⇒ `Response`

#list_publications(compartment_id, listing_type, opts = {}) ⇒ `Response`

#list_publishers(opts = {}) ⇒ `Response`

#list_report_types(compartment_id, opts = {}) ⇒ `Response`

#list_reports(report_type, date, compartment_id, opts = {}) ⇒ `Response`

#list_taxes(listing_id, opts = {}) ⇒ `Response`

#logger ⇒ `Logger`

#search_listings(search_listings_details, opts = {}) ⇒ `Response`

#update_accepted_agreement(accepted_agreement_id, update_accepted_agreement_details, opts = {}) ⇒ `Response`

#update_publication(publication_id, update_publication_details, opts = {}) ⇒ `Response`