Class CustomAPITransferNode (0.37.0)

public final class CustomAPITransferNode extends GeneratedMessage implements CustomAPITransferNodeOrBuilder

Container for a specific API interaction.

Protobuf type google.cloud.chronicle.v1.CustomAPITransferNode

Static Fields

CHECKPOINTING_FIELD_NUMBER

public static final int CHECKPOINTING_FIELD_NUMBER
Field Value
Type Description
int

DEPENDENT_REQUESTS_CONFIG_FIELD_NUMBER

public static final int DEPENDENT_REQUESTS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PAGINATION_STRATEGY_FIELD_NUMBER

public static final int PAGINATION_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_SETTINGS_FIELD_NUMBER

public static final int REQUEST_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_MAPPING_FIELD_NUMBER

public static final int RESPONSE_MAPPING_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomAPITransferNode getDefaultInstance()
Returns
Type Description
CustomAPITransferNode

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CustomAPITransferNode.Builder newBuilder()
Returns
Type Description
CustomAPITransferNode.Builder

newBuilder(CustomAPITransferNode prototype)

public static CustomAPITransferNode.Builder newBuilder(CustomAPITransferNode prototype)
Parameter
Name Description
prototype CustomAPITransferNode
Returns
Type Description
CustomAPITransferNode.Builder

parseDelimitedFrom(InputStream input)

public static CustomAPITransferNode parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAPITransferNode parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CustomAPITransferNode parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomAPITransferNode parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomAPITransferNode parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomAPITransferNode parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomAPITransferNode parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAPITransferNode parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CustomAPITransferNode parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAPITransferNode parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CustomAPITransferNode parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomAPITransferNode parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAPITransferNode
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CustomAPITransferNode> parser()
Returns
Type Description
Parser<CustomAPITransferNode>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCheckpointing()

public CustomAPICheckpointConfig getCheckpointing()

Required. Configure settings that allow the connector to remember where it left off in the previous poll (e.g., tracking the last fetched timestamp).

.google.cloud.chronicle.v1.CustomAPICheckpointConfig checkpointing = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomAPICheckpointConfig

The checkpointing.

getCheckpointingOrBuilder()

public CustomAPICheckpointConfigOrBuilder getCheckpointingOrBuilder()

Required. Configure settings that allow the connector to remember where it left off in the previous poll (e.g., tracking the last fetched timestamp).

.google.cloud.chronicle.v1.CustomAPICheckpointConfig checkpointing = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomAPICheckpointConfigOrBuilder

getDefaultInstanceForType()

public CustomAPITransferNode getDefaultInstanceForType()
Returns
Type Description
CustomAPITransferNode

getDependentRequestsConfig()

public CustomAPIDependentRequestsConfig getDependentRequestsConfig()

Optional. Configuration for dependent requests (child chaining).

.google.cloud.chronicle.v1.CustomAPIDependentRequestsConfig dependent_requests_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomAPIDependentRequestsConfig

The dependentRequestsConfig.

getDependentRequestsConfigOrBuilder()

public CustomAPIDependentRequestsConfigOrBuilder getDependentRequestsConfigOrBuilder()

Optional. Configuration for dependent requests (child chaining).

.google.cloud.chronicle.v1.CustomAPIDependentRequestsConfig dependent_requests_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomAPIDependentRequestsConfigOrBuilder

getPaginationStrategy()

public CustomAPIPagination getPaginationStrategy()

Required. Select how the connector should request subsequent pages when the data is too large for a single response.

.google.cloud.chronicle.v1.CustomAPIPagination pagination_strategy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomAPIPagination

The paginationStrategy.

getPaginationStrategyOrBuilder()

public CustomAPIPaginationOrBuilder getPaginationStrategyOrBuilder()

Required. Select how the connector should request subsequent pages when the data is too large for a single response.

.google.cloud.chronicle.v1.CustomAPIPagination pagination_strategy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomAPIPaginationOrBuilder

getParserForType()

public Parser<CustomAPITransferNode> getParserForType()
Returns
Type Description
Parser<CustomAPITransferNode>
Overrides

getRequestSettings()

public CustomAPIRequestConfig getRequestSettings()

Required. Define the technical parameters for the outgoing API call, including paths, headers, and payloads.

.google.cloud.chronicle.v1.CustomAPIRequestConfig request_settings = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomAPIRequestConfig

The requestSettings.

getRequestSettingsOrBuilder()

public CustomAPIRequestConfigOrBuilder getRequestSettingsOrBuilder()

Required. Define the technical parameters for the outgoing API call, including paths, headers, and payloads.

.google.cloud.chronicle.v1.CustomAPIRequestConfig request_settings = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomAPIRequestConfigOrBuilder

getResponseMapping()

public CustomAPIResponseConfig getResponseMapping()

Required. Provide rules that tell the platform how to locate and extract the relevant security data from the API's reply.

.google.cloud.chronicle.v1.CustomAPIResponseConfig response_mapping = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomAPIResponseConfig

The responseMapping.

getResponseMappingOrBuilder()

public CustomAPIResponseConfigOrBuilder getResponseMappingOrBuilder()

Required. Provide rules that tell the platform how to locate and extract the relevant security data from the API's reply.

.google.cloud.chronicle.v1.CustomAPIResponseConfig response_mapping = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomAPIResponseConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCheckpointing()

public boolean hasCheckpointing()

Required. Configure settings that allow the connector to remember where it left off in the previous poll (e.g., tracking the last fetched timestamp).

.google.cloud.chronicle.v1.CustomAPICheckpointConfig checkpointing = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the checkpointing field is set.

hasDependentRequestsConfig()

public boolean hasDependentRequestsConfig()

Optional. Configuration for dependent requests (child chaining).

.google.cloud.chronicle.v1.CustomAPIDependentRequestsConfig dependent_requests_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dependentRequestsConfig field is set.

hasPaginationStrategy()

public boolean hasPaginationStrategy()

Required. Select how the connector should request subsequent pages when the data is too large for a single response.

.google.cloud.chronicle.v1.CustomAPIPagination pagination_strategy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the paginationStrategy field is set.

hasRequestSettings()

public boolean hasRequestSettings()

Required. Define the technical parameters for the outgoing API call, including paths, headers, and payloads.

.google.cloud.chronicle.v1.CustomAPIRequestConfig request_settings = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the requestSettings field is set.

hasResponseMapping()

public boolean hasResponseMapping()

Required. Provide rules that tell the platform how to locate and extract the relevant security data from the API's reply.

.google.cloud.chronicle.v1.CustomAPIResponseConfig response_mapping = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the responseMapping field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CustomAPITransferNode.Builder newBuilderForType()
Returns
Type Description
CustomAPITransferNode.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CustomAPITransferNode.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomAPITransferNode.Builder
Overrides

toBuilder()

public CustomAPITransferNode.Builder toBuilder()
Returns
Type Description
CustomAPITransferNode.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException