Class CustomAPIRequestConfig (0.37.0)

public final class CustomAPIRequestConfig extends GeneratedMessage implements CustomAPIRequestConfigOrBuilder

Configuration for the outgoing API request.

Protobuf type google.cloud.chronicle.v1.CustomAPIRequestConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > CustomAPIRequestConfig

Implements

CustomAPIRequestConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CUSTOM_HEADERS_FIELD_NUMBER

public static final int CUSTOM_HEADERS_FIELD_NUMBER

Field Value
Type	Description
`int`

ENDPOINT_PATH_FIELD_NUMBER

public static final int ENDPOINT_PATH_FIELD_NUMBER

Field Value
Type	Description
`int`

HTTP_METHOD_FIELD_NUMBER

public static final int HTTP_METHOD_FIELD_NUMBER

Field Value
Type	Description
`int`

MAX_REQUESTS_PER_MINUTE_FIELD_NUMBER

public static final int MAX_REQUESTS_PER_MINUTE_FIELD_NUMBER

Field Value
Type	Description
`int`

QUERY_PARAMETERS_FIELD_NUMBER

public static final int QUERY_PARAMETERS_FIELD_NUMBER

Field Value
Type	Description
`int`

REQUEST_BODY_FIELD_NUMBER

public static final int REQUEST_BODY_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static CustomAPIRequestConfig getDefaultInstance()

Returns
Type	Description
`CustomAPIRequestConfig`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static CustomAPIRequestConfig.Builder newBuilder()

Returns
Type	Description
`CustomAPIRequestConfig.Builder`

newBuilder(CustomAPIRequestConfig prototype)

public static CustomAPIRequestConfig.Builder newBuilder(CustomAPIRequestConfig prototype)

Parameter
Name	Description
`prototype`	`CustomAPIRequestConfig`

Returns
Type	Description
`CustomAPIRequestConfig.Builder`

parseDelimitedFrom(InputStream input)

public static CustomAPIRequestConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAPIRequestConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static CustomAPIRequestConfig parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomAPIRequestConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static CustomAPIRequestConfig parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomAPIRequestConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static CustomAPIRequestConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAPIRequestConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static CustomAPIRequestConfig parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAPIRequestConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static CustomAPIRequestConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomAPIRequestConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomAPIRequestConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<CustomAPIRequestConfig> parser()

Returns
Type	Description
`Parser<CustomAPIRequestConfig>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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`

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`

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.

getParserForType()

public Parser<CustomAPIRequestConfig> getParserForType()

Returns
Type	Description
`Parser<CustomAPIRequestConfig>`

Overrides

GeneratedMessage.getParserForType()