@Generated(value="OracleSDKGenerator", comments="API Version: 20181001") public class MarketplaceClient extends Object implements Marketplace
Modifier and Type | Class and Description |
---|---|
static class |
MarketplaceClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Marketplace.
|
Modifier | Constructor and Description |
---|---|
|
MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static MarketplaceClient.Builder |
builder()
Create a builder for this client.
|
void |
close() |
CreateAcceptedAgreementResponse |
createAcceptedAgreement(CreateAcceptedAgreementRequest request)
Accepts a terms of use agreement for a specific package version of a listing.
|
DeleteAcceptedAgreementResponse |
deleteAcceptedAgreement(DeleteAcceptedAgreementRequest request)
Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks
before initiating a deployment.
|
GetAcceptedAgreementResponse |
getAcceptedAgreement(GetAcceptedAgreementRequest request)
Gets the details of a specific, previously accepted terms of use agreement.
|
GetAgreementResponse |
getAgreement(GetAgreementRequest request)
Returns a terms of use agreement for a package with a time-based signature that can be used to
accept the agreement.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetListingResponse |
getListing(GetListingRequest request)
Gets detailed information about a listing, including the listing’s name, version, description, and
resources.
|
GetPackageResponse |
getPackage(GetPackageRequest request)
Get the details of the specified version of a package, including information needed to launch the package.
|
MarketplacePaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
ListAcceptedAgreementsResponse |
listAcceptedAgreements(ListAcceptedAgreementsRequest request)
Lists the terms of use agreements that have been accepted in the specified compartment.
|
ListAgreementsResponse |
listAgreements(ListAgreementsRequest request)
Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.
|
ListCategoriesResponse |
listCategories(ListCategoriesRequest request)
Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace.
|
ListListingsResponse |
listListings(ListListingsRequest request)
Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and
filtering according to listing attributes.
|
ListPackagesResponse |
listPackages(ListPackagesRequest request)
Gets the list of packages for a listing.
|
ListPublishersResponse |
listPublishers(ListPublishersRequest request)
Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.
|
ListReportsResponse |
listReports(ListReportsRequest request)
Lists reports in the compartment that match the specified report type and date.
|
ListReportTypesResponse |
listReportTypes(ListReportTypesRequest request)
Lists available types of reports for the compartment.
|
ListTaxesResponse |
listTaxes(ListTaxesRequest request)
Returns list of all tax implications that current tenant may be liable to once they launch the listing.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateAcceptedAgreementResponse |
updateAcceptedAgreement(UpdateAcceptedAgreementRequest request)
Updates the display name or tags associated with a listing’s previously accepted terms of use agreement.
|
public static final Service SERVICE
Service instance for Marketplace.
public MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)protected MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the MarketplaceClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)restClientFactoryBuilder
- the builder for the RestClientFactory
public static MarketplaceClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
Marketplace
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface Marketplace
endpoint
- The endpoint of the service.public String getEndpoint()
Marketplace
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface Marketplace
public void setRegion(Region region)
Marketplace
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
setRegion
in interface Marketplace
region
- The region of the service.public void setRegion(String regionId)
Marketplace
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call
setRegion
.
If no known Region could be determined, it will create an endpoint based on the
default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
setRegion
in interface Marketplace
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public CreateAcceptedAgreementResponse createAcceptedAgreement(CreateAcceptedAgreementRequest request)
Marketplace
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.
createAcceptedAgreement
in interface Marketplace
request
- The request object containing the details to sendpublic DeleteAcceptedAgreementResponse deleteAcceptedAgreement(DeleteAcceptedAgreementRequest request)
Marketplace
Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks before initiating a deployment. Listings in the Marketplace that require acceptance of the specified terms of use can no longer be deployed, but existing deployments aren’t affected.
deleteAcceptedAgreement
in interface Marketplace
request
- The request object containing the details to sendpublic GetAcceptedAgreementResponse getAcceptedAgreement(GetAcceptedAgreementRequest request)
Marketplace
Gets the details of a specific, previously accepted terms of use agreement.
getAcceptedAgreement
in interface Marketplace
request
- The request object containing the details to sendpublic GetAgreementResponse getAgreement(GetAgreementRequest request)
Marketplace
Returns a terms of use agreement for a package with a time-based signature that can be used to accept the agreement.
getAgreement
in interface Marketplace
request
- The request object containing the details to sendpublic GetListingResponse getListing(GetListingRequest request)
Marketplace
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](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://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](https://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](https://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](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.
getListing
in interface Marketplace
request
- The request object containing the details to sendpublic GetPackageResponse getPackage(GetPackageRequest request)
Marketplace
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](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://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](https://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](https://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](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.
getPackage
in interface Marketplace
request
- The request object containing the details to sendpublic ListAcceptedAgreementsResponse listAcceptedAgreements(ListAcceptedAgreementsRequest request)
Marketplace
Lists the terms of use agreements that have been accepted in the specified compartment. You can filter results by specifying query parameters.
listAcceptedAgreements
in interface Marketplace
request
- The request object containing the details to sendpublic ListAgreementsResponse listAgreements(ListAgreementsRequest request)
Marketplace
Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.
listAgreements
in interface Marketplace
request
- The request object containing the details to sendpublic ListCategoriesResponse listCategories(ListCategoriesRequest request)
Marketplace
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.
listCategories
in interface Marketplace
request
- The request object containing the details to sendpublic ListListingsResponse listListings(ListListingsRequest request)
Marketplace
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](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://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](https://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](https://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](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.
listListings
in interface Marketplace
request
- The request object containing the details to sendpublic ListPackagesResponse listPackages(ListPackagesRequest request)
Marketplace
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](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://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](https://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](https://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](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.
listPackages
in interface Marketplace
request
- The request object containing the details to sendpublic ListPublishersResponse listPublishers(ListPublishersRequest request)
Marketplace
Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.
listPublishers
in interface Marketplace
request
- The request object containing the details to sendpublic ListReportTypesResponse listReportTypes(ListReportTypesRequest request)
Marketplace
Lists available types of reports for the compartment.
listReportTypes
in interface Marketplace
request
- The request object containing the details to sendpublic ListReportsResponse listReports(ListReportsRequest request)
Marketplace
Lists reports in the compartment that match the specified report type and date.
listReports
in interface Marketplace
request
- The request object containing the details to sendpublic ListTaxesResponse listTaxes(ListTaxesRequest request)
Marketplace
Returns list of all tax implications that current tenant may be liable to once they launch the listing.
listTaxes
in interface Marketplace
request
- The request object containing the details to sendpublic UpdateAcceptedAgreementResponse updateAcceptedAgreement(UpdateAcceptedAgreementRequest request)
Marketplace
Updates the display name or tags associated with a listing’s previously accepted terms of use agreement.
updateAcceptedAgreement
in interface Marketplace
request
- The request object containing the details to sendpublic MarketplacePaginators getPaginators()
Marketplace
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data. These paginators provide an Iterable
interface so that service responses, or
resources/records, can be iterated through without having to manually deal with pagination and page tokens.
getPaginators
in interface Marketplace
Copyright © 2016–2021. All rights reserved.