Class OdapackageClient

Service client instance for Odapackage.

Inheritance

object

ClientBase

RegionalClientBase

OdapackageClient

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)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OdaService

Assembly: OCI.DotNetSDK.Oda.dll

Syntax

public class OdapackageClient : RegionalClientBase, IDisposable

Constructors

OdapackageClient(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 OdapackageClient(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 OdapackagePaginators Paginators { get; }

Property Value

Type	Description
OdapackagePaginators

Methods

CreateImportedPackage(CreateImportedPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts an asynchronous job to import a package into a Digital Assistant instance. <br/> To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestId}.

Declaration

public Task<CreateImportedPackageResponse> CreateImportedPackage(CreateImportedPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteImportedPackage(DeleteImportedPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts an asynchronous job to delete a package from a Digital Assistant instance. <br/> To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestId}.

Declaration

public Task<DeleteImportedPackageResponse> DeleteImportedPackage(DeleteImportedPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetImportedPackage(GetImportedPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of summaries for imported packages in the instance.

Declaration

public Task<GetImportedPackageResponse> GetImportedPackage(GetImportedPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetPackage(GetPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns details about a package, and how to import it.

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.

ListImportedPackages(ListImportedPackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of summaries for imported packages in the instance.

Declaration

public Task<ListImportedPackagesResponse> ListImportedPackages(ListImportedPackagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListPackages(ListPackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a page of summaries for packages that are available for import. The optional odaInstanceId query parameter can be used to filter packages that are available for import by a specific instance. If odaInstanceId query parameter is not provided, the returned list will include packages available within the region indicated by the request URL. The optional resourceType query param may be specified to filter packages that contain the indicated resource type. If no resourceType query param is given, packages containing all resource types will be returned. The optional name query parameter can be used to limit the list to packages whose name matches the given name. The optional displayName query parameter can be used to limit the list to packages whose displayName matches the given name. The optional isLatestVersionOnly query parameter can be used to limit the returned list to include only the latest version of any given package. If not specified, all versions of any otherwise matching package will be returned. <br/> If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

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.

UpdateImportedPackage(UpdateImportedPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts an asynchronous job to update a package within a Digital Assistant instance. <br/> To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestId}.

Declaration

public Task<UpdateImportedPackageResponse> UpdateImportedPackage(UpdateImportedPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable