Show / Hide Table of Contents

Class JmsUtilsClient

Service client instance for JmsUtils.

Inheritance
object
ClientBase
RegionalClientBase
JmsUtilsClient
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.JmsutilsService
Assembly: OCI.DotNetSDK.Jmsutils.dll
Syntax
public class JmsUtilsClient : RegionalClientBase, IDisposable

Constructors

JmsUtilsClient(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 JmsUtilsClient(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 JmsUtilsPaginators Paginators { get; }
Property Value
Type Description
JmsUtilsPaginators

Waiters

Declaration
public JmsUtilsWaiters Waiters { get; }
Property Value
Type Description
JmsUtilsWaiters

Methods

CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels a work request.

Declaration
public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelWorkRequestRequest 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<CancelWorkRequestResponse>

A response object containing details about the completed operation

Examples

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

DeleteJavaMigrationAnalysis(DeleteJavaMigrationAnalysisRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Java Migration Analysis.

Declaration
public Task<DeleteJavaMigrationAnalysisResponse> DeleteJavaMigrationAnalysis(DeleteJavaMigrationAnalysisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteJavaMigrationAnalysisRequest 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<DeleteJavaMigrationAnalysisResponse>

A response object containing details about the completed operation

Examples

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

DeletePerformanceTuningAnalysis(DeletePerformanceTuningAnalysisRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Performance Tuning Analysis.

Declaration
public Task<DeletePerformanceTuningAnalysisResponse> DeletePerformanceTuningAnalysis(DeletePerformanceTuningAnalysisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeletePerformanceTuningAnalysisRequest 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<DeletePerformanceTuningAnalysisResponse>

A response object containing details about the completed operation

Examples

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

GetAnalyzeApplicationsConfiguration(GetAnalyzeApplicationsConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the configuration for analyzing applications.

Declaration
public Task<GetAnalyzeApplicationsConfigurationResponse> GetAnalyzeApplicationsConfiguration(GetAnalyzeApplicationsConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetAnalyzeApplicationsConfigurationRequest 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<GetAnalyzeApplicationsConfigurationResponse>

A response object containing details about the completed operation

Examples

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

GetJavaMigrationAnalysis(GetJavaMigrationAnalysisRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a Java Migration Analysis.

Declaration
public Task<GetJavaMigrationAnalysisResponse> GetJavaMigrationAnalysis(GetJavaMigrationAnalysisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetJavaMigrationAnalysisRequest 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<GetJavaMigrationAnalysisResponse>

A response object containing details about the completed operation

Examples

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

GetPerformanceTuningAnalysis(GetPerformanceTuningAnalysisRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a Performance Tuning Analysis.

Declaration
public Task<GetPerformanceTuningAnalysisResponse> GetPerformanceTuningAnalysis(GetPerformanceTuningAnalysisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetPerformanceTuningAnalysisRequest 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<GetPerformanceTuningAnalysisResponse>

A response object containing details about the completed operation

Examples

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

GetSubscriptionAcknowledgmentConfiguration(GetSubscriptionAcknowledgmentConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the configuration for subscription acknowledgment.

Declaration
public Task<GetSubscriptionAcknowledgmentConfigurationResponse> GetSubscriptionAcknowledgmentConfiguration(GetSubscriptionAcknowledgmentConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetSubscriptionAcknowledgmentConfigurationRequest 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<GetSubscriptionAcknowledgmentConfigurationResponse>

A response object containing details about the completed operation

Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a 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.

ListJavaMigrationAnalysis(ListJavaMigrationAnalysisRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of Java Migration Analysis.

Declaration
public Task<ListJavaMigrationAnalysisResponse> ListJavaMigrationAnalysis(ListJavaMigrationAnalysisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListJavaMigrationAnalysisRequest 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<ListJavaMigrationAnalysisResponse>

A response object containing details about the completed operation

Examples

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

ListPerformanceTuningAnalysis(ListPerformanceTuningAnalysisRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of Performance tuning Analysis.

Declaration
public Task<ListPerformanceTuningAnalysisResponse> ListPerformanceTuningAnalysis(ListPerformanceTuningAnalysisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListPerformanceTuningAnalysisRequest 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<ListPerformanceTuningAnalysisResponse>

A response object containing details about the completed operation

Examples

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

ListWorkItems(ListWorkItemsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieve a paginated list of work items for a specified work request.

Declaration
public Task<ListWorkItemsResponse> ListWorkItems(ListWorkItemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkItemsRequest 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<ListWorkItemsResponse>

A response object containing details about the completed operation

Examples

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

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the 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)

Lists the 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)

Lists the 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.

RequestJavaMigrationAnalysis(RequestJavaMigrationAnalysisRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Requests Java Migration Analysis.

Declaration
public Task<RequestJavaMigrationAnalysisResponse> RequestJavaMigrationAnalysis(RequestJavaMigrationAnalysisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RequestJavaMigrationAnalysisRequest 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<RequestJavaMigrationAnalysisResponse>

A response object containing details about the completed operation

Examples

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

RequestPerformanceTuningAnalysis(RequestPerformanceTuningAnalysisRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Requests Performance Tuning Analysis.

Declaration
public Task<RequestPerformanceTuningAnalysisResponse> RequestPerformanceTuningAnalysis(RequestPerformanceTuningAnalysisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RequestPerformanceTuningAnalysisRequest 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<RequestPerformanceTuningAnalysisResponse>

A response object containing details about the completed operation

Examples

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

UpdateAnalyzeApplicationsConfiguration(UpdateAnalyzeApplicationsConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the configuration for analyze application.

Declaration
public Task<UpdateAnalyzeApplicationsConfigurationResponse> UpdateAnalyzeApplicationsConfiguration(UpdateAnalyzeApplicationsConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateAnalyzeApplicationsConfigurationRequest 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<UpdateAnalyzeApplicationsConfigurationResponse>

A response object containing details about the completed operation

Examples

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

UpdateSubscriptionAcknowledgmentConfiguration(UpdateSubscriptionAcknowledgmentConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the configuration for subscription acknowledgment.

Declaration
public Task<UpdateSubscriptionAcknowledgmentConfigurationResponse> UpdateSubscriptionAcknowledgmentConfiguration(UpdateSubscriptionAcknowledgmentConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateSubscriptionAcknowledgmentConfigurationRequest 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<UpdateSubscriptionAcknowledgmentConfigurationResponse>

A response object containing details about the completed operation

Examples

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

Implements

IDisposable
In this article
Back to top