Class MarketplaceClient
Service client instance for Marketplace.
Implements
Inherited Members
Namespace: Oci.MarketplaceService
Assembly: OCI.DotNetSDK.Marketplace.dll
Syntax
public class MarketplaceClient : RegionalClientBase, IDisposable
Constructors
MarketplaceClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public MarketplaceClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public MarketplacePaginators Paginators { get; }
Property Value
Type | Description |
---|---|
MarketplacePaginators |
Waiters
Declaration
public MarketplaceWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
MarketplaceWaiters |
Methods
ChangePublicationCompartment(ChangePublicationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves the specified publication from one compartment to another.
Declaration
public Task<ChangePublicationCompartmentResponse> ChangePublicationCompartment(ChangePublicationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangePublicationCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangePublicationCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangePublicationCompartment API.
CreateAcceptedAgreement(CreateAcceptedAgreementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<CreateAcceptedAgreementResponse> CreateAcceptedAgreement(CreateAcceptedAgreementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAcceptedAgreementRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateAcceptedAgreementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAcceptedAgreement API.
CreatePublication(CreatePublicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a publication of the specified listing type with an optional default package.
Declaration
public Task<CreatePublicationResponse> CreatePublication(CreatePublicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePublicationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePublicationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePublication API.
DeleteAcceptedAgreement(DeleteAcceptedAgreementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<DeleteAcceptedAgreementResponse> DeleteAcceptedAgreement(DeleteAcceptedAgreementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAcceptedAgreementRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteAcceptedAgreementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAcceptedAgreement API.
DeletePublication(DeletePublicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a publication, which also removes the associated listing from anywhere it was published, such as Marketplace or Compute.
Declaration
public Task<DeletePublicationResponse> DeletePublication(DeletePublicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePublicationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePublicationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePublication API.
ExportListing(ExportListingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Exports container images or helm chart from marketplace to customer's registry.
Declaration
public Task<ExportListingResponse> ExportListing(ExportListingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExportListingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ExportListingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExportListing API.
GetAcceptedAgreement(GetAcceptedAgreementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of a specific, previously accepted terms of use agreement.
Declaration
public Task<GetAcceptedAgreementResponse> GetAcceptedAgreement(GetAcceptedAgreementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAcceptedAgreementRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAcceptedAgreementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAcceptedAgreement API.
GetAgreement(GetAgreementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a terms of use agreement for a package with a time-based signature that can be used to accept the agreement.
Declaration
public Task<GetAgreementResponse> GetAgreement(GetAgreementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAgreementRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAgreementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAgreement API.
GetListing(GetListingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets detailed information about a listing, including the listing's name, version, description, and resources. <br/> 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. <br/> 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 API call. The 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 API call. <br/> To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.
Declaration
public Task<GetListingResponse> GetListing(GetListingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetListingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetListingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetListing API.
GetPackage(GetPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the details of the specified version of a package, including information needed to launch the package. <br/> 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. <br/> 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 API call. The 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 API call. <br/> To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.
Declaration
public Task<GetPackageResponse> GetPackage(GetPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPackageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPackageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPackage API.
GetPublication(GetPublicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of the specified publication.
Declaration
public Task<GetPublicationResponse> GetPublication(GetPublicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPublicationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPublicationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPublication API.
GetPublicationPackage(GetPublicationPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of a specific package version within a given publication.
Declaration
public Task<GetPublicationPackageResponse> GetPublicationPackage(GetPublicationPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPublicationPackageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPublicationPackageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPublicationPackage API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of the specified work request
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ListAcceptedAgreements(ListAcceptedAgreementsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the terms of use agreements that have been accepted in the specified compartment. You can filter results by specifying query parameters.
Declaration
public Task<ListAcceptedAgreementsResponse> ListAcceptedAgreements(ListAcceptedAgreementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAcceptedAgreementsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAcceptedAgreementsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAcceptedAgreements API.
ListAgreements(ListAgreementsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.
Declaration
public Task<ListAgreementsResponse> ListAgreements(ListAgreementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAgreementsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAgreementsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAgreements API.
ListCategories(ListCategoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListCategoriesResponse> ListCategories(ListCategoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCategoriesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCategoriesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCategories API.
ListListings(ListListingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and filtering according to listing attributes. <br/> 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. <br/> 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 API call. The 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 API call. <br/> To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.
Declaration
public Task<ListListingsResponse> ListListings(ListListingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListListingsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListListingsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListListings API.
ListPackages(ListPackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the list of packages for a listing. <br/> 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. <br/> 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 API call. The 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 API call. <br/> To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.
Declaration
public Task<ListPackagesResponse> ListPackages(ListPackagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPackagesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPackagesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPackages API.
ListPublicationPackages(ListPublicationPackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the packages in the specified publication.
Declaration
public Task<ListPublicationPackagesResponse> ListPublicationPackages(ListPublicationPackagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPublicationPackagesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPublicationPackagesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPublicationPackages API.
ListPublications(ListPublicationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the publications in the specified compartment.
Declaration
public Task<ListPublicationsResponse> ListPublications(ListPublicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPublicationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPublicationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPublications API.
ListPublishers(ListPublishersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.
Declaration
public Task<ListPublishersResponse> ListPublishers(ListPublishersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPublishersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPublishersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPublishers API.
ListReportTypes(ListReportTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists available types of reports for the compartment.
Declaration
public Task<ListReportTypesResponse> ListReportTypes(ListReportTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListReportTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListReportTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListReportTypes API.
ListReports(ListReportsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists reports in the compartment that match the specified report type and date.
Declaration
public Task<ListReportsResponse> ListReports(ListReportsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListReportsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListReportsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListReports API.
ListTaxes(ListTaxesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns list of all tax implications that current tenant may be liable to once they launch the listing.
Declaration
public Task<ListTaxesResponse> ListTaxes(ListTaxesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTaxesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTaxesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTaxes API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List all errors for a work request
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List all logs for a work request
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List all work requests in a compartment
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
SearchListings(SearchListingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<SearchListingsResponse> SearchListings(SearchListingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SearchListingsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SearchListingsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SearchListings API.
UpdateAcceptedAgreement(UpdateAcceptedAgreementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the display name or tags associated with a listing's previously accepted terms of use agreement.
Declaration
public Task<UpdateAcceptedAgreementResponse> UpdateAcceptedAgreement(UpdateAcceptedAgreementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAcceptedAgreementRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateAcceptedAgreementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAcceptedAgreement API.
UpdatePublication(UpdatePublicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the details of an existing publication.
Declaration
public Task<UpdatePublicationResponse> UpdatePublication(UpdatePublicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePublicationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePublicationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePublication API.