public static final class CustomAPIRequestConfig.Builder extends GeneratedMessage.Builder<CustomAPIRequestConfig.Builder> implements CustomAPIRequestConfigOrBuilderConfiguration for the outgoing API request.
Protobuf type google.cloud.chronicle.v1.CustomAPIRequestConfig
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CustomAPIRequestConfig.BuilderImplements
CustomAPIRequestConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllCustomHeaders(Iterable<? extends HeaderKeyValue> values)
public CustomAPIRequestConfig.Builder addAllCustomHeaders(Iterable<? extends HeaderKeyValue> values)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 |
values |
Iterable<? extends com.google.cloud.chronicle.v1.HeaderKeyValue> |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
addAllQueryParameters(Iterable<? extends HeaderKeyValue> values)
public CustomAPIRequestConfig.Builder addAllQueryParameters(Iterable<? extends HeaderKeyValue> values)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 |
values |
Iterable<? extends com.google.cloud.chronicle.v1.HeaderKeyValue> |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
addCustomHeaders(HeaderKeyValue value)
public CustomAPIRequestConfig.Builder addCustomHeaders(HeaderKeyValue value)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 |
value |
HeaderKeyValue |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
addCustomHeaders(HeaderKeyValue.Builder builderForValue)
public CustomAPIRequestConfig.Builder addCustomHeaders(HeaderKeyValue.Builder builderForValue)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 |
builderForValue |
HeaderKeyValue.Builder |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
addCustomHeaders(int index, HeaderKeyValue value)
public CustomAPIRequestConfig.Builder addCustomHeaders(int index, HeaderKeyValue value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
HeaderKeyValue |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
addCustomHeaders(int index, HeaderKeyValue.Builder builderForValue)
public CustomAPIRequestConfig.Builder addCustomHeaders(int index, HeaderKeyValue.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
HeaderKeyValue.Builder |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
addCustomHeadersBuilder()
public HeaderKeyValue.Builder addCustomHeadersBuilder()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 |
HeaderKeyValue.Builder |
|
addCustomHeadersBuilder(int index)
public HeaderKeyValue.Builder addCustomHeadersBuilder(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.Builder |
|
addQueryParameters(HeaderKeyValue value)
public CustomAPIRequestConfig.Builder addQueryParameters(HeaderKeyValue value)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 |
value |
HeaderKeyValue |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
addQueryParameters(HeaderKeyValue.Builder builderForValue)
public CustomAPIRequestConfig.Builder addQueryParameters(HeaderKeyValue.Builder builderForValue)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 |
builderForValue |
HeaderKeyValue.Builder |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
addQueryParameters(int index, HeaderKeyValue value)
public CustomAPIRequestConfig.Builder addQueryParameters(int index, HeaderKeyValue value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
HeaderKeyValue |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
addQueryParameters(int index, HeaderKeyValue.Builder builderForValue)
public CustomAPIRequestConfig.Builder addQueryParameters(int index, HeaderKeyValue.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
HeaderKeyValue.Builder |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
addQueryParametersBuilder()
public HeaderKeyValue.Builder addQueryParametersBuilder()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 |
HeaderKeyValue.Builder |
|
addQueryParametersBuilder(int index)
public HeaderKeyValue.Builder addQueryParametersBuilder(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.Builder |
|
build()
public CustomAPIRequestConfig build()| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig |
|
buildPartial()
public CustomAPIRequestConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig |
|
clear()
public CustomAPIRequestConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
clearCustomHeaders()
public CustomAPIRequestConfig.Builder clearCustomHeaders()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 |
CustomAPIRequestConfig.Builder |
|
clearEndpointPath()
public CustomAPIRequestConfig.Builder clearEndpointPath()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 |
CustomAPIRequestConfig.Builder |
This builder for chaining. |
clearHttpMethod()
public CustomAPIRequestConfig.Builder clearHttpMethod()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.Builder |
This builder for chaining. |
clearMaxRequestsPerMinute()
public CustomAPIRequestConfig.Builder clearMaxRequestsPerMinute()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 |
CustomAPIRequestConfig.Builder |
This builder for chaining. |
clearQueryParameters()
public CustomAPIRequestConfig.Builder clearQueryParameters()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 |
CustomAPIRequestConfig.Builder |
|
clearRequestBody()
public CustomAPIRequestConfig.Builder clearRequestBody()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 |
CustomAPIRequestConfig.Builder |
This builder for chaining. |
getCustomHeaders(int index)
public 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 |
|
getCustomHeadersBuilder(int index)
public HeaderKeyValue.Builder getCustomHeadersBuilder(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.Builder |
|
getCustomHeadersBuilderList()
public List<HeaderKeyValue.Builder> getCustomHeadersBuilderList()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<Builder> |
|
getCustomHeadersCount()
public 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 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 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 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> |
|
getDefaultInstanceForType()
public CustomAPIRequestConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEndpointPath()
public 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 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 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 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 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 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 |
|
getQueryParametersBuilder(int index)
public HeaderKeyValue.Builder getQueryParametersBuilder(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.Builder |
|
getQueryParametersBuilderList()
public List<HeaderKeyValue.Builder> getQueryParametersBuilderList()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<Builder> |
|
getQueryParametersCount()
public 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CustomAPIRequestConfig other)
public CustomAPIRequestConfig.Builder mergeFrom(CustomAPIRequestConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
CustomAPIRequestConfig |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CustomAPIRequestConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CustomAPIRequestConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
removeCustomHeaders(int index)
public CustomAPIRequestConfig.Builder removeCustomHeaders(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 |
CustomAPIRequestConfig.Builder |
|
removeQueryParameters(int index)
public CustomAPIRequestConfig.Builder removeQueryParameters(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 |
CustomAPIRequestConfig.Builder |
|
setCustomHeaders(int index, HeaderKeyValue value)
public CustomAPIRequestConfig.Builder setCustomHeaders(int index, HeaderKeyValue value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
HeaderKeyValue |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
setCustomHeaders(int index, HeaderKeyValue.Builder builderForValue)
public CustomAPIRequestConfig.Builder setCustomHeaders(int index, HeaderKeyValue.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
HeaderKeyValue.Builder |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
setEndpointPath(String value)
public CustomAPIRequestConfig.Builder setEndpointPath(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe endpointPath to set. |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
This builder for chaining. |
setEndpointPathBytes(ByteString value)
public CustomAPIRequestConfig.Builder setEndpointPathBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for endpointPath to set. |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
This builder for chaining. |
setHttpMethod(CustomAPIRequestConfig.HttpMethod value)
public CustomAPIRequestConfig.Builder setHttpMethod(CustomAPIRequestConfig.HttpMethod value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CustomAPIRequestConfig.HttpMethodThe httpMethod to set. |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
This builder for chaining. |
setHttpMethodValue(int value)
public CustomAPIRequestConfig.Builder setHttpMethodValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for httpMethod to set. |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
This builder for chaining. |
setMaxRequestsPerMinute(int value)
public CustomAPIRequestConfig.Builder setMaxRequestsPerMinute(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe maxRequestsPerMinute to set. |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
This builder for chaining. |
setQueryParameters(int index, HeaderKeyValue value)
public CustomAPIRequestConfig.Builder setQueryParameters(int index, HeaderKeyValue value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
HeaderKeyValue |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
setQueryParameters(int index, HeaderKeyValue.Builder builderForValue)
public CustomAPIRequestConfig.Builder setQueryParameters(int index, HeaderKeyValue.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
HeaderKeyValue.Builder |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
|
setRequestBody(String value)
public CustomAPIRequestConfig.Builder setRequestBody(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe requestBody to set. |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
This builder for chaining. |
setRequestBodyBytes(ByteString value)
public CustomAPIRequestConfig.Builder setRequestBodyBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for requestBody to set. |
| Returns | |
|---|---|
| Type | Description |
CustomAPIRequestConfig.Builder |
This builder for chaining. |