Chronicle v1 API - Class CustomAPISettings (1.1.0) 

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

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

Settings required by Feeds of Custom API (Codeless). Supports fetching data from third-party APIs with configurable pagination, authentication, and response parsing.

Inheritance

object > CustomAPISettings

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

CustomAPISettings()

public CustomAPISettings()

CustomAPISettings(CustomAPISettings)

public CustomAPISettings(CustomAPISettings other)
Parameter
Name Description
other CustomAPISettings

Properties

AuthenticationCase

public CustomAPISettings.AuthenticationOneofCase AuthenticationCase { get; }
Property Value
Type Description
CustomAPISettingsAuthenticationOneofCase

BaseUrl

public string BaseUrl { get; set; }

Required. Enter the primary web address of the third-party API (e.g., https://api.vendor.com).

Property Value
Type Description
string

BasicAuth

public UsernameSecretAuth BasicAuth { get; set; }

Authenticate using Username/Password credentials.

Property Value
Type Description
UsernameSecretAuth

HeaderAuth

public CustomAPIHeaderAuth HeaderAuth { get; set; }

Authenticate using custom API Keys injected into request headers.

Property Value
Type Description
CustomAPIHeaderAuth

NoAuth

public CustomAPINoAuth NoAuth { get; set; }

Authenticate without credentials or secrets.

Property Value
Type Description
CustomAPINoAuth

OauthClientCredentials

public OAuthClientCredentials OauthClientCredentials { get; set; }

Authenticate using OAuth 2.0 Client Credentials Grant flow.

Property Value
Type Description
OAuthClientCredentials

PollingFrequency

public int PollingFrequency { get; set; }

Optional. Specify how often the platform checks the API for new data in minutes (default is 15 minutes).

Property Value
Type Description
int

PrimaryRequest

public CustomAPITransferNode PrimaryRequest { get; set; }

Required. Configure the initial API call used to fetch the main list of logs or events.

Property Value
Type Description
CustomAPITransferNode

QueryAuth

public CustomAPIQueryAuth QueryAuth { get; set; }

Authenticate using custom API Keys injected into URL query parameters.

Property Value
Type Description
CustomAPIQueryAuth