Class CustomAPIRequestConfig.Builder (0.37.0)

0.37.0 (latest) 0.33.0 0.32.0 0.31.0 0.29.0 0.26.0 0.25.0 0.23.0 0.21.0 0.20.0 0.19.0 0.18.0 0.16.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.6.0 0.5.0 0.2.0 0.1.0

public static final class CustomAPIRequestConfig.Builder extends GeneratedMessage.Builder<CustomAPIRequestConfig.Builder> implements CustomAPIRequestConfigOrBuilder

Configuration 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.Builder

Implements

CustomAPIRequestConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

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

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CustomAPIRequestConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CustomAPIRequestConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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	String The 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	ByteString The 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.HttpMethod The 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	int The 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	int The 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	String The 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	ByteString The bytes for requestBody to set.

Returns
Type	Description
CustomAPIRequestConfig.Builder	This builder for chaining.