/// <summary>
/// Retrieves the run for the specified `runId`.
///
/// </summary>
/// <param name="request">The request object containing the details to send. Required.</param>
/// <param name="retryConfiguration">The retry configuration that will be used by to send this request. Optional.</param>
/// <param name="cancellationToken">The cancellation token to cancel this operation. Optional.</param>
/// <returns>A response object containing details about the completed operation</returns>
public async Task <GetRunResponse> GetRun(GetRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
{
logger.Trace("Called getRun");
Uri uri = new Uri(this.restClient.GetEndpoint(), System.IO.Path.Combine(basePathWithoutHost, "/runs/{runId}".Trim('/')));
HttpMethod method = new HttpMethod("Get");
HttpRequestMessage requestMessage = Converter.ToHttpRequestMessage(uri, method, request);
requestMessage.Headers.Add("Accept", "application/json");
GenericRetrier retryingClient = Retrier.GetPreferredRetrier(retryConfiguration, this.retryConfiguration);
HttpResponseMessage responseMessage;
try
{
if (retryingClient != null)
{
responseMessage = await retryingClient.MakeRetryingCall(this.restClient.HttpSend, requestMessage, cancellationToken);
}
else
{
responseMessage = await this.restClient.HttpSend(requestMessage);
}
return(Converter.FromHttpResponseMessage <GetRunResponse>(responseMessage));
}
catch (Exception e)
{
logger.Error($"GetRun failed with error: {e.Message}");
throw;
}
}
/// <summary>
/// Creates a waiter using the provided configuration.
/// </summary>
/// <param name="request">Request to send.</param>
/// <param name="config">Wait Configuration</param>
/// <param name="targetStates">Desired resource states. If multiple states are provided then the waiter will return once the resource reaches any of the provided states</param>
/// <returns>a new Oci.common.Waiter instance</returns>
public Waiter <GetRunRequest, GetRunResponse> ForRun(GetRunRequest request, WaiterConfiguration config, params RunLifecycleState[] targetStates)
{
var agent = new WaiterAgent <GetRunRequest, GetRunResponse>(
request,
request => client.GetRun(request),
response => targetStates.Contains(response.Run.LifecycleState.Value)
);
return(new Waiter <GetRunRequest, GetRunResponse>(config, agent));
}
private void HandleOutput(GetRunRequest request)
{
var waiterConfig = new WaiterConfiguration
{
MaxAttempts = MaxWaitAttempts,
GetNextDelayInSeconds = (_) => WaitIntervalSeconds
};
switch (ParameterSetName)
{
case LifecycleStateParamSet:
response = client.Waiters.ForRun(request, waiterConfig, WaitForLifecycleState).Execute();
break;
case Default:
response = client.GetRun(request).GetAwaiter().GetResult();
break;
}
WriteOutput(response, response.Run);
}
protected override void ProcessRecord()
{
base.ProcessRecord();
GetRunRequest request;
try
{
request = new GetRunRequest
{
RunId = RunId,
OpcRequestId = OpcRequestId
};
HandleOutput(request);
FinishProcessing(response);
}
catch (Exception ex)
{
TerminatingErrorDuringExecution(ex);
}
}
public void TestGetDocumentParagraphRun()
{
string remoteFileName = "TestGetDocumentParagraphRun.docx";
this.UploadFileToStorage(
remoteDataFolder + "/" + remoteFileName,
null,
null,
File.ReadAllBytes(LocalTestDataFolder + localFile)
);
var request = new GetRunRequest(
name: remoteFileName,
paragraphPath: "paragraphs/0",
index: 0,
folder: remoteDataFolder
);
var actual = this.WordsApi.GetRun(request);
Assert.NotNull(actual.Run);
Assert.AreEqual("Page ", actual.Run.Text);
}
/// <summary>
/// Creates a waiter using default wait configuration.
/// </summary>
/// <param name="request">Request to send.</param>
/// <param name="targetStates">Desired resource states. If multiple states are provided then the waiter will return once the resource reaches any of the provided states</param>
/// <returns>a new Oci.common.Waiter instance</returns>
public Waiter <GetRunRequest, GetRunResponse> ForRun(GetRunRequest request, params RunLifecycleState[] targetStates)
{
return(this.ForRun(request, WaiterConfiguration.DefaultWaiterConfiguration, targetStates));
}
public GetRunResponse GetRun(GetRunRequest request, IRequestOptions options = null)
{
return(WebClient.Send(request, options));
}
public GetRunResponse GetRun(GetRunRequest request, IRequestOptions options = null)
{
return(WebClient.Send <GetRunResponse>(HttpMethods.GET, request.BuildUrl(ClientSettings.Version), null, options));
}
public static string BuildUrl(this GetRunRequest req, string version)
{
return(string.Format("{0}/runs/{1}", version, req.Id));
}