C# Class Amazon.XRay.AmazonXRayClient

Implementation for accessing XRay AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
Inheritance: AmazonServiceClient, IAmazonXRay
Show file Open project: aws/aws-sdk-net

Public Methods

Method Description
AmazonXRayClient ( ) : System

Constructs AmazonXRayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonXRayClient ( AWSCredentials credentials ) : System

Constructs AmazonXRayClient with AWS Credentials
AmazonXRayClient ( AWSCredentials credentials, AmazonXRayConfig clientConfig ) : System

Constructs AmazonXRayClient with AWS Credentials and an AmazonXRayClient Configuration object.
AmazonXRayClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonXRayClient with AWS Credentials
AmazonXRayClient ( AmazonXRayConfig config ) : System

Constructs AmazonXRayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonXRayClient ( RegionEndpoint region ) : System

Constructs AmazonXRayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key
AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonXRayConfig clientConfig ) : System

Constructs AmazonXRayClient with AWS Access Key ID, AWS Secret Key and an AmazonXRayClient Configuration object.
AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key
AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key
AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonXRayConfig clientConfig ) : System

Constructs AmazonXRayClient with AWS Access Key ID, AWS Secret Key and an AmazonXRayClient Configuration object.
AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key
BatchGetTraces ( BatchGetTracesRequest request ) : BatchGetTracesResponse

Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.
BatchGetTracesAsync ( BatchGetTracesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the BatchGetTraces operation.
BeginBatchGetTraces ( BatchGetTracesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the BatchGetTraces operation.
BeginGetServiceGraph ( GetServiceGraphRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetServiceGraph operation.
BeginGetTraceGraph ( GetTraceGraphRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetTraceGraph operation.
BeginGetTraceSummaries ( GetTraceSummariesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetTraceSummaries operation.
BeginPutTelemetryRecords ( PutTelemetryRecordsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the PutTelemetryRecords operation.
BeginPutTraceSegments ( PutTraceSegmentsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the PutTraceSegments operation.
EndBatchGetTraces ( IAsyncResult asyncResult ) : BatchGetTracesResponse

Finishes the asynchronous execution of the BatchGetTraces operation.
EndGetServiceGraph ( IAsyncResult asyncResult ) : GetServiceGraphResponse

Finishes the asynchronous execution of the GetServiceGraph operation.
EndGetTraceGraph ( IAsyncResult asyncResult ) : GetTraceGraphResponse

Finishes the asynchronous execution of the GetTraceGraph operation.
EndGetTraceSummaries ( IAsyncResult asyncResult ) : GetTraceSummariesResponse

Finishes the asynchronous execution of the GetTraceSummaries operation.
EndPutTelemetryRecords ( IAsyncResult asyncResult ) : PutTelemetryRecordsResponse

Finishes the asynchronous execution of the PutTelemetryRecords operation.
EndPutTraceSegments ( IAsyncResult asyncResult ) : PutTraceSegmentsResponse

Finishes the asynchronous execution of the PutTraceSegments operation.
GetServiceGraph ( GetServiceGraphRequest request ) : GetServiceGraphResponse

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.
GetServiceGraphAsync ( GetServiceGraphRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetServiceGraph operation.
GetTraceGraph ( GetTraceGraphRequest request ) : GetTraceGraphResponse

Retrieves a service graph for one or more specific trace IDs.
GetTraceGraphAsync ( GetTraceGraphRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetTraceGraph operation.
GetTraceSummaries ( GetTraceSummariesRequest request ) : GetTraceSummariesResponse

Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.
GetTraceSummariesAsync ( GetTraceSummariesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetTraceSummaries operation.
PutTelemetryRecords ( PutTelemetryRecordsRequest request ) : PutTelemetryRecordsResponse

Used by the AWS X-Ray daemon to upload telemetry.
PutTelemetryRecordsAsync ( PutTelemetryRecordsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the PutTelemetryRecords operation.
PutTraceSegments ( PutTraceSegmentsRequest request ) : PutTraceSegmentsResponse

Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.
PutTraceSegmentsAsync ( PutTraceSegmentsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the PutTraceSegments operation.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.
Dispose ( bool disposing ) : void

Disposes the service client.

Method Details

AmazonXRayClient() public method

Constructs AmazonXRayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonXRayClient ( ) : System
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with AWS Credentials
public AmazonXRayClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with AWS Credentials and an AmazonXRayClient Configuration object.
public AmazonXRayClient ( AWSCredentials credentials, AmazonXRayConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonXRayConfig The AmazonXRayClient Configuration Object
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with AWS Credentials
public AmazonXRayClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonXRayClient ( AmazonXRayConfig config ) : System
config AmazonXRayConfig The AmazonXRayClient Configuration Object
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonXRayClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key
public AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with AWS Access Key ID, AWS Secret Key and an AmazonXRayClient Configuration object.
public AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonXRayConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonXRayConfig The AmazonXRayClient Configuration Object
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key
public AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key
public AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with AWS Access Key ID, AWS Secret Key and an AmazonXRayClient Configuration object.
public AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonXRayConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonXRayConfig The AmazonXRayClient Configuration Object
return System

AmazonXRayClient() public method

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key
public AmazonXRayClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

BatchGetTraces() public method

Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.
/// The request is missing required parameters or has invalid parameters. /// /// The request exceeds the maximum number of requests per second. ///
public BatchGetTraces ( BatchGetTracesRequest request ) : BatchGetTracesResponse
request Amazon.XRay.Model.BatchGetTracesRequest Container for the necessary parameters to execute the BatchGetTraces service method.
return Amazon.XRay.Model.BatchGetTracesResponse

BatchGetTracesAsync() public method

Initiates the asynchronous execution of the BatchGetTraces operation.
public BatchGetTracesAsync ( BatchGetTracesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.XRay.Model.BatchGetTracesRequest Container for the necessary parameters to execute the BatchGetTraces operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

BeginBatchGetTraces() public method

Initiates the asynchronous execution of the BatchGetTraces operation.
public BeginBatchGetTraces ( BatchGetTracesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.XRay.Model.BatchGetTracesRequest Container for the necessary parameters to execute the BatchGetTraces operation on AmazonXRayClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetServiceGraph() public method

Initiates the asynchronous execution of the GetServiceGraph operation.
public BeginGetServiceGraph ( GetServiceGraphRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.XRay.Model.GetServiceGraphRequest Container for the necessary parameters to execute the GetServiceGraph operation on AmazonXRayClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetTraceGraph() public method

Initiates the asynchronous execution of the GetTraceGraph operation.
public BeginGetTraceGraph ( GetTraceGraphRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.XRay.Model.GetTraceGraphRequest Container for the necessary parameters to execute the GetTraceGraph operation on AmazonXRayClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetTraceSummaries() public method

Initiates the asynchronous execution of the GetTraceSummaries operation.
public BeginGetTraceSummaries ( GetTraceSummariesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.XRay.Model.GetTraceSummariesRequest Container for the necessary parameters to execute the GetTraceSummaries operation on AmazonXRayClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginPutTelemetryRecords() public method

Initiates the asynchronous execution of the PutTelemetryRecords operation.
public BeginPutTelemetryRecords ( PutTelemetryRecordsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.XRay.Model.PutTelemetryRecordsRequest Container for the necessary parameters to execute the PutTelemetryRecords operation on AmazonXRayClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginPutTraceSegments() public method

Initiates the asynchronous execution of the PutTraceSegments operation.
public BeginPutTraceSegments ( PutTraceSegmentsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.XRay.Model.PutTraceSegmentsRequest Container for the necessary parameters to execute the PutTraceSegments operation on AmazonXRayClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return Amazon.Runtime.Internal.Auth.AbstractAWSSigner

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EndBatchGetTraces() public method

Finishes the asynchronous execution of the BatchGetTraces operation.
public EndBatchGetTraces ( IAsyncResult asyncResult ) : BatchGetTracesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginBatchGetTraces.
return Amazon.XRay.Model.BatchGetTracesResponse

EndGetServiceGraph() public method

Finishes the asynchronous execution of the GetServiceGraph operation.
public EndGetServiceGraph ( IAsyncResult asyncResult ) : GetServiceGraphResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetServiceGraph.
return Amazon.XRay.Model.GetServiceGraphResponse

EndGetTraceGraph() public method

Finishes the asynchronous execution of the GetTraceGraph operation.
public EndGetTraceGraph ( IAsyncResult asyncResult ) : GetTraceGraphResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetTraceGraph.
return Amazon.XRay.Model.GetTraceGraphResponse

EndGetTraceSummaries() public method

Finishes the asynchronous execution of the GetTraceSummaries operation.
public EndGetTraceSummaries ( IAsyncResult asyncResult ) : GetTraceSummariesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetTraceSummaries.
return Amazon.XRay.Model.GetTraceSummariesResponse

EndPutTelemetryRecords() public method

Finishes the asynchronous execution of the PutTelemetryRecords operation.
public EndPutTelemetryRecords ( IAsyncResult asyncResult ) : PutTelemetryRecordsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginPutTelemetryRecords.
return PutTelemetryRecordsResponse

EndPutTraceSegments() public method

Finishes the asynchronous execution of the PutTraceSegments operation.
public EndPutTraceSegments ( IAsyncResult asyncResult ) : PutTraceSegmentsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginPutTraceSegments.
return Amazon.XRay.Model.PutTraceSegmentsResponse

GetServiceGraph() public method

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.
/// The request is missing required parameters or has invalid parameters. /// /// The request exceeds the maximum number of requests per second. ///
public GetServiceGraph ( GetServiceGraphRequest request ) : GetServiceGraphResponse
request Amazon.XRay.Model.GetServiceGraphRequest Container for the necessary parameters to execute the GetServiceGraph service method.
return Amazon.XRay.Model.GetServiceGraphResponse

GetServiceGraphAsync() public method

Initiates the asynchronous execution of the GetServiceGraph operation.
public GetServiceGraphAsync ( GetServiceGraphRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.XRay.Model.GetServiceGraphRequest Container for the necessary parameters to execute the GetServiceGraph operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetTraceGraph() public method

Retrieves a service graph for one or more specific trace IDs.
/// The request is missing required parameters or has invalid parameters. /// /// The request exceeds the maximum number of requests per second. ///
public GetTraceGraph ( GetTraceGraphRequest request ) : GetTraceGraphResponse
request Amazon.XRay.Model.GetTraceGraphRequest Container for the necessary parameters to execute the GetTraceGraph service method.
return Amazon.XRay.Model.GetTraceGraphResponse

GetTraceGraphAsync() public method

Initiates the asynchronous execution of the GetTraceGraph operation.
public GetTraceGraphAsync ( GetTraceGraphRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.XRay.Model.GetTraceGraphRequest Container for the necessary parameters to execute the GetTraceGraph operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetTraceSummaries() public method

Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.
/// The request is missing required parameters or has invalid parameters. /// /// The request exceeds the maximum number of requests per second. ///
public GetTraceSummaries ( GetTraceSummariesRequest request ) : GetTraceSummariesResponse
request Amazon.XRay.Model.GetTraceSummariesRequest Container for the necessary parameters to execute the GetTraceSummaries service method.
return Amazon.XRay.Model.GetTraceSummariesResponse

GetTraceSummariesAsync() public method

Initiates the asynchronous execution of the GetTraceSummaries operation.
public GetTraceSummariesAsync ( GetTraceSummariesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.XRay.Model.GetTraceSummariesRequest Container for the necessary parameters to execute the GetTraceSummaries operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PutTelemetryRecords() public method

Used by the AWS X-Ray daemon to upload telemetry.
/// The request is missing required parameters or has invalid parameters. /// /// The request exceeds the maximum number of requests per second. ///
public PutTelemetryRecords ( PutTelemetryRecordsRequest request ) : PutTelemetryRecordsResponse
request Amazon.XRay.Model.PutTelemetryRecordsRequest Container for the necessary parameters to execute the PutTelemetryRecords service method.
return PutTelemetryRecordsResponse

PutTelemetryRecordsAsync() public method

Initiates the asynchronous execution of the PutTelemetryRecords operation.
public PutTelemetryRecordsAsync ( PutTelemetryRecordsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.XRay.Model.PutTelemetryRecordsRequest Container for the necessary parameters to execute the PutTelemetryRecords operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PutTraceSegments() public method

Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.
/// The request is missing required parameters or has invalid parameters. /// /// The request exceeds the maximum number of requests per second. ///
public PutTraceSegments ( PutTraceSegmentsRequest request ) : PutTraceSegmentsResponse
request Amazon.XRay.Model.PutTraceSegmentsRequest Container for the necessary parameters to execute the PutTraceSegments service method.
return Amazon.XRay.Model.PutTraceSegmentsResponse

PutTraceSegmentsAsync() public method

Initiates the asynchronous execution of the PutTraceSegments operation.
public PutTraceSegmentsAsync ( PutTraceSegmentsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.XRay.Model.PutTraceSegmentsRequest Container for the necessary parameters to execute the PutTraceSegments operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task