Google Cloud Chronicle V1 Client - Class CustomAPISettings (0.7.1)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class CustomAPISettings.

Settings required by Feeds of Custom API (Codeless).

Supports fetching data from third-party APIs with configurable pagination, authentication, and response parsing.

Generated from protobuf message google.cloud.chronicle.v1.CustomAPISettings

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ no_auth`	`CustomAPINoAuth` Authenticate without credentials or secrets.
`↳ basic_auth`	`UsernameSecretAuth` Authenticate using Username/Password credentials.
`↳ oauth_client_credentials`	`OAuthClientCredentials` Authenticate using OAuth 2.0 Client Credentials Grant flow.
`↳ header_auth`	`CustomAPIHeaderAuth` Authenticate using custom API Keys injected into request headers.
`↳ query_auth`	`CustomAPIQueryAuth` Authenticate using custom API Keys injected into URL query parameters.
`↳ base_url`	`string` Required. Enter the primary web address of the third-party API (e.g., https://api.vendor.com).
`↳ polling_frequency`	`int` Optional. Specify how often the platform checks the API for new data in minutes (default is 15 minutes).
`↳ primary_request`	`CustomAPITransferNode` Required. Configure the initial API call used to fetch the main list of logs or events.

getNoAuth

Authenticate without credentials or secrets.

Returns
Type	Description
`CustomAPINoAuth\|null`

hasNoAuth

setNoAuth

Authenticate without credentials or secrets.

Parameter
Name	Description
`var`	`CustomAPINoAuth`

Returns
Type	Description
`$this`

getBasicAuth

Authenticate using Username/Password credentials.

Returns
Type	Description
`UsernameSecretAuth\|null`

hasBasicAuth

setBasicAuth

Authenticate using Username/Password credentials.

Parameter
Name	Description
`var`	`UsernameSecretAuth`

Returns
Type	Description
`$this`

getOauthClientCredentials

Authenticate using OAuth 2.0 Client Credentials Grant flow.

Returns
Type	Description
`OAuthClientCredentials\|null`

hasOauthClientCredentials

setOauthClientCredentials

Authenticate using OAuth 2.0 Client Credentials Grant flow.

Parameter
Name	Description
`var`	`OAuthClientCredentials`

Returns
Type	Description
`$this`

getHeaderAuth

Authenticate using custom API Keys injected into request headers.

Returns
Type	Description
`CustomAPIHeaderAuth\|null`

hasHeaderAuth

setHeaderAuth

Authenticate using custom API Keys injected into request headers.

Parameter
Name	Description
`var`	`CustomAPIHeaderAuth`

Returns
Type	Description
`$this`

getQueryAuth

Authenticate using custom API Keys injected into URL query parameters.

Returns
Type	Description
`CustomAPIQueryAuth\|null`

hasQueryAuth

setQueryAuth