Class ProductClient

Service client instance for Product.

Inheritance

object

ClientBase

RegionalClientBase

ProductClient

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 ProductClient : RegionalClientBase, IDisposable

Constructors

ProductClient(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 ProductClient(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 ProductPaginators Paginators { get; }

Property Value

Type	Description
ProductPaginators

Waiters

Declaration

public ProductWaiters Waiters { get; }

Property Value

Type	Description
ProductWaiters

Methods

ActivateProduct(ActivateProductRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Activate the target Product. Change lifecycleState from INACTIVE to ACTIVE.

Declaration

public Task<ActivateProductResponse> ActivateProduct(ActivateProductRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetProduct(GetProductRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get product by ID

Declaration

public Task<GetProductResponse> GetProduct(GetProductRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListProducts(ListProductsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List products

Declaration

public Task<ListProductsResponse> ListProducts(ListProductsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable