Skip to content

Latest commit

 

History

History
168 lines (105 loc) · 6.15 KB

ShieldInformationBarrierSegments.md

File metadata and controls

168 lines (105 loc) · 6.15 KB

IShieldInformationBarrierSegmentsManager

Get shield information barrier segment with specified ID

Retrieves shield information barrier segment based on provided ID..

This operation is performed by calling function GetShieldInformationBarrierSegmentById.

See the endpoint docs at API Reference.

await client.ShieldInformationBarrierSegments.GetShieldInformationBarrierSegmentByIdAsync(shieldInformationBarrierSegmentId: segmentId);

Arguments

  • shieldInformationBarrierSegmentId string
    • The ID of the shield information barrier segment. Example: "3423"
  • headers GetShieldInformationBarrierSegmentByIdHeaders
    • Headers of getShieldInformationBarrierSegmentById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type ShieldInformationBarrierSegment.

Returns the shield information barrier segment object.

Delete shield information barrier segment

Deletes the shield information barrier segment based on provided ID.

This operation is performed by calling function DeleteShieldInformationBarrierSegmentById.

See the endpoint docs at API Reference.

await client.ShieldInformationBarrierSegments.DeleteShieldInformationBarrierSegmentByIdAsync(shieldInformationBarrierSegmentId: segmentId);

Arguments

  • shieldInformationBarrierSegmentId string
    • The ID of the shield information barrier segment. Example: "3423"
  • headers DeleteShieldInformationBarrierSegmentByIdHeaders
    • Headers of deleteShieldInformationBarrierSegmentById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type null.

Empty body in response

Update shield information barrier segment with specified ID

Updates the shield information barrier segment based on provided ID..

This operation is performed by calling function UpdateShieldInformationBarrierSegmentById.

See the endpoint docs at API Reference.

await client.ShieldInformationBarrierSegments.UpdateShieldInformationBarrierSegmentByIdAsync(shieldInformationBarrierSegmentId: segmentId, requestBody: new UpdateShieldInformationBarrierSegmentByIdRequestBody() { Description = updatedSegmentDescription });

Arguments

  • shieldInformationBarrierSegmentId string
    • The ID of the shield information barrier segment. Example: "3423"
  • requestBody UpdateShieldInformationBarrierSegmentByIdRequestBody
    • Request body of updateShieldInformationBarrierSegmentById method
  • headers UpdateShieldInformationBarrierSegmentByIdHeaders
    • Headers of updateShieldInformationBarrierSegmentById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type ShieldInformationBarrierSegment.

Returns the updated shield information barrier segment object.

List shield information barrier segments

Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.

This operation is performed by calling function GetShieldInformationBarrierSegments.

See the endpoint docs at API Reference.

await client.ShieldInformationBarrierSegments.GetShieldInformationBarrierSegmentsAsync(queryParams: new GetShieldInformationBarrierSegmentsQueryParams(shieldInformationBarrierId: barrierId));

Arguments

  • queryParams GetShieldInformationBarrierSegmentsQueryParams
    • Query parameters of getShieldInformationBarrierSegments method
  • headers GetShieldInformationBarrierSegmentsHeaders
    • Headers of getShieldInformationBarrierSegments method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type ShieldInformationBarrierSegments.

Returns a paginated list of shield information barrier segment objects.

Create shield information barrier segment

Creates a shield information barrier segment.

This operation is performed by calling function CreateShieldInformationBarrierSegment.

See the endpoint docs at API Reference.

await client.ShieldInformationBarrierSegments.CreateShieldInformationBarrierSegmentAsync(requestBody: new CreateShieldInformationBarrierSegmentRequestBody(shieldInformationBarrier: new ShieldInformationBarrierBase() { Id = barrierId, Type = ShieldInformationBarrierBaseTypeField.ShieldInformationBarrier }, name: segmentName) { Description = segmentDescription });

Arguments

  • requestBody CreateShieldInformationBarrierSegmentRequestBody
    • Request body of createShieldInformationBarrierSegment method
  • headers CreateShieldInformationBarrierSegmentHeaders
    • Headers of createShieldInformationBarrierSegment method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type ShieldInformationBarrierSegment.

Returns a new shield information barrier segment object.