Google Cloud Chronicle V1 Client - Class CustomAPIRequestConfig (0.7.1)

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

Configuration for the outgoing API request.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ endpoint_path`	`string` Required. Enter the specific API route appended to the Base URL to fetch the data (e.g., /v1/alerts).
`↳ http_method`	`int` Required. Select the type of action to perform on the API endpoint (usually GET to retrieve data or POST to submit a query).
`↳ request_body`	`string` Optional. Provide the data payload sent to the API to specify what information you want, typically formatted in JSON.
`↳ query_parameters`	`array<HeaderKeyValue>` Optional. Add extra filters or settings appended to the end of the URL (e.g., ?status=critical).
`↳ custom_headers`	`array<HeaderKeyValue>` Optional. Define specialized key-value pairs sent with the request, often used for custom API versioning or specific vendor requirements.
`↳ max_requests_per_minute`	`int` Optional. Set a safety limit to ensure the connector does not exceed the third-party vendor's API rate limits.

getEndpointPath

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

Returns
Type	Description
`string`

setEndpointPath

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHttpMethod

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

Returns
Type	Description
`int`	Enum of type HttpMethod.

setHttpMethod

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

Parameter
Name	Description
`var`	`int` Enum of type HttpMethod.

Returns
Type	Description
`$this`

getRequestBody

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

Returns
Type	Description
`string`

setRequestBody

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getQueryParameters

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

Returns
Type	Description
`Google\Protobuf\RepeatedField<HeaderKeyValue>`

setQueryParameters