Chronicle v1 API - Class CustomAPIRequestConfig (1.1.0) 

public sealed class CustomAPIRequestConfig : IMessage<CustomAPIRequestConfig>, IEquatable<CustomAPIRequestConfig>, IDeepCloneable<CustomAPIRequestConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Chronicle v1 API class CustomAPIRequestConfig.

Configuration for the outgoing API request.

Inheritance

object > CustomAPIRequestConfig

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

CustomAPIRequestConfig()

public CustomAPIRequestConfig()

CustomAPIRequestConfig(CustomAPIRequestConfig)

public CustomAPIRequestConfig(CustomAPIRequestConfig other)
Parameter
Name Description
other CustomAPIRequestConfig

Properties

CustomHeaders

public RepeatedField<HeaderKeyValue> CustomHeaders { get; }

Optional. Define specialized key-value pairs sent with the request, often used for custom API versioning or specific vendor requirements.

Property Value
Type Description
RepeatedFieldHeaderKeyValue

EndpointPath

public string EndpointPath { get; set; }

Required. Enter the specific API route appended to the Base URL to fetch the data (e.g., /v1/alerts).

Property Value
Type Description
string

HttpMethod

public CustomAPIRequestConfig.Types.HttpMethod HttpMethod { get; set; }

Required. Select the type of action to perform on the API endpoint (usually GET to retrieve data or POST to submit a query).

Property Value
Type Description
CustomAPIRequestConfigTypesHttpMethod

MaxRequestsPerMinute

public int MaxRequestsPerMinute { get; set; }

Optional. Set a safety limit to ensure the connector does not exceed the third-party vendor's API rate limits.

Property Value
Type Description
int

QueryParameters

public RepeatedField<HeaderKeyValue> QueryParameters { get; }

Optional. Add extra filters or settings appended to the end of the URL (e.g., ?status=critical).

Property Value
Type Description
RepeatedFieldHeaderKeyValue

RequestBody

public string RequestBody { get; set; }

Optional. Provide the data payload sent to the API to specify what information you want, typically formatted in JSON.

Property Value
Type Description
string