Class ProductAdminClient

Service client instance for ProductAdmin.

Inheritance

object

ClientBase

RegionalClientBase

ProductAdminClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

ClientBase.EnableDualStackEndpoints(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OciproductcatalogService

Assembly: OCI.DotNetSDK.Ociproductcatalog.dll

Syntax

public class ProductAdminClient : RegionalClientBase, IDisposable

Constructors

ProductAdminClient(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 ProductAdminClient(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 ProductAdminPaginators Paginators { get; }

Property Value

Type	Description
ProductAdminPaginators

Waiters

Declaration

public ProductAdminWaiters Waiters { get; }

Property Value

Type	Description
ProductAdminWaiters

Methods

ChangeAdminProductCompartment(ChangeAdminProductCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change product compartment

Declaration

public Task<ChangeAdminProductCompartmentResponse> ChangeAdminProductCompartment(ChangeAdminProductCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeAdminProductCompartmentRequest	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<ChangeAdminProductCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeAdminProductCompartment API.

CreateAdminProduct(CreateAdminProductRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Used by the OCI service teams to create a product to control the availability of the relative resources

Declaration

public Task<CreateAdminProductResponse> CreateAdminProduct(CreateAdminProductRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAdminProductRequest	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<CreateAdminProductResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateAdminProduct API.

DeleteAdminProduct(DeleteAdminProductRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete the product

Declaration

public Task<DeleteAdminProductResponse> DeleteAdminProduct(DeleteAdminProductRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAdminProductRequest	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<DeleteAdminProductResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteAdminProduct API.

GetAdminProduct(GetAdminProductRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the product by ID

Declaration

public Task<GetAdminProductResponse> GetAdminProduct(GetAdminProductRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAdminProductRequest	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<GetAdminProductResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAdminProduct API.

ListAdminProducts(ListAdminProductsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List the products with the filters

Declaration

public Task<ListAdminProductsResponse> ListAdminProducts(ListAdminProductsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAdminProductsRequest	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<ListAdminProductsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAdminProducts API.

UpdateAdminProduct(UpdateAdminProductRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the product

Declaration

public Task<UpdateAdminProductResponse> UpdateAdminProduct(UpdateAdminProductRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAdminProductRequest	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<UpdateAdminProductResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateAdminProduct API.

Implements

IDisposable