Interface CustomAPIRequestConfigOrBuilder (0.37.0) 

public interface CustomAPIRequestConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCustomHeaders(int index)

public abstract HeaderKeyValue getCustomHeaders(int index)

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

repeated .google.cloud.chronicle.v1.HeaderKeyValue custom_headers = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
HeaderKeyValue

getCustomHeadersCount()

public abstract int getCustomHeadersCount()

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

repeated .google.cloud.chronicle.v1.HeaderKeyValue custom_headers = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCustomHeadersList()

public abstract List<HeaderKeyValue> getCustomHeadersList()

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

repeated .google.cloud.chronicle.v1.HeaderKeyValue custom_headers = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<HeaderKeyValue>

getCustomHeadersOrBuilder(int index)

public abstract HeaderKeyValueOrBuilder getCustomHeadersOrBuilder(int index)

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

repeated .google.cloud.chronicle.v1.HeaderKeyValue custom_headers = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
HeaderKeyValueOrBuilder

getCustomHeadersOrBuilderList()

public abstract List<? extends HeaderKeyValueOrBuilder> getCustomHeadersOrBuilderList()

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

repeated .google.cloud.chronicle.v1.HeaderKeyValue custom_headers = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.chronicle.v1.HeaderKeyValueOrBuilder>

getEndpointPath()

public abstract String getEndpointPath()

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

string endpoint_path = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The endpointPath.

getEndpointPathBytes()

public abstract ByteString getEndpointPathBytes()

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

string endpoint_path = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for endpointPath.

getHttpMethod()

public abstract CustomAPIRequestConfig.HttpMethod getHttpMethod()

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

.google.cloud.chronicle.v1.CustomAPIRequestConfig.HttpMethod http_method = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomAPIRequestConfig.HttpMethod

The httpMethod.

getHttpMethodValue()

public abstract int getHttpMethodValue()

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

.google.cloud.chronicle.v1.CustomAPIRequestConfig.HttpMethod http_method = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for httpMethod.

getMaxRequestsPerMinute()

public abstract int getMaxRequestsPerMinute()

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

int32 max_requests_per_minute = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The maxRequestsPerMinute.

getQueryParameters(int index)

public abstract HeaderKeyValue getQueryParameters(int index)

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

repeated .google.cloud.chronicle.v1.HeaderKeyValue query_parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
HeaderKeyValue

getQueryParametersCount()

public abstract int getQueryParametersCount()

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

repeated .google.cloud.chronicle.v1.HeaderKeyValue query_parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getQueryParametersList()

public abstract List<HeaderKeyValue> getQueryParametersList()

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

repeated .google.cloud.chronicle.v1.HeaderKeyValue query_parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<HeaderKeyValue>

getQueryParametersOrBuilder(int index)

public abstract HeaderKeyValueOrBuilder getQueryParametersOrBuilder(int index)

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

repeated .google.cloud.chronicle.v1.HeaderKeyValue query_parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
HeaderKeyValueOrBuilder

getQueryParametersOrBuilderList()

public abstract List<? extends HeaderKeyValueOrBuilder> getQueryParametersOrBuilderList()

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

repeated .google.cloud.chronicle.v1.HeaderKeyValue query_parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.chronicle.v1.HeaderKeyValueOrBuilder>

getRequestBody()

public abstract String getRequestBody()

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

string request_body = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The requestBody.

getRequestBodyBytes()

public abstract ByteString getRequestBodyBytes()

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

string request_body = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for requestBody.