Class CustomAPISettings (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 final class CustomAPISettings extends GeneratedMessage implements CustomAPISettingsOrBuilder

Settings required by Feeds of Custom API (Codeless). Supports fetching data from third-party APIs with configurable pagination, authentication, and response parsing.

Protobuf type google.cloud.chronicle.v1.CustomAPISettings

Inheritance

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

Implements

CustomAPISettingsOrBuilder

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

BASE_URL_FIELD_NUMBER

public static final int BASE_URL_FIELD_NUMBER

Field Value
Type	Description
int

BASIC_AUTH_FIELD_NUMBER

public static final int BASIC_AUTH_FIELD_NUMBER

Field Value
Type	Description
int

HEADER_AUTH_FIELD_NUMBER

public static final int HEADER_AUTH_FIELD_NUMBER

Field Value
Type	Description
int

NO_AUTH_FIELD_NUMBER

public static final int NO_AUTH_FIELD_NUMBER

Field Value
Type	Description
int

OAUTH_CLIENT_CREDENTIALS_FIELD_NUMBER

public static final int OAUTH_CLIENT_CREDENTIALS_FIELD_NUMBER

Field Value
Type	Description
int

POLLING_FREQUENCY_FIELD_NUMBER

public static final int POLLING_FREQUENCY_FIELD_NUMBER

Field Value
Type	Description
int

PRIMARY_REQUEST_FIELD_NUMBER

public static final int PRIMARY_REQUEST_FIELD_NUMBER

Field Value
Type	Description
int

QUERY_AUTH_FIELD_NUMBER

public static final int QUERY_AUTH_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static CustomAPISettings getDefaultInstance()

Returns
Type	Description
CustomAPISettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static CustomAPISettings.Builder newBuilder()

Returns
Type	Description
CustomAPISettings.Builder

newBuilder(CustomAPISettings prototype)

public static CustomAPISettings.Builder newBuilder(CustomAPISettings prototype)

Parameter
Name	Description
prototype	CustomAPISettings

Returns
Type	Description
CustomAPISettings.Builder

parseDelimitedFrom(InputStream input)

public static CustomAPISettings parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAPISettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static CustomAPISettings parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomAPISettings parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomAPISettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomAPISettings parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAPISettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static CustomAPISettings parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAPISettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static CustomAPISettings parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomAPISettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomAPISettings

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<CustomAPISettings> parser()

Returns
Type	Description
Parser<CustomAPISettings>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAuthenticationCase()

public CustomAPISettings.AuthenticationCase getAuthenticationCase()

Returns
Type	Description
CustomAPISettings.AuthenticationCase

getBaseUrl()

public String getBaseUrl()

Required. Enter the primary web address of the third-party API (e.g., https://api.vendor.com).

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

Returns
Type	Description
String	The baseUrl.

getBaseUrlBytes()

public ByteString getBaseUrlBytes()

Required. Enter the primary web address of the third-party API (e.g., https://api.vendor.com).

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

Returns
Type	Description
ByteString	The bytes for baseUrl.

getBasicAuth()

public UsernameSecretAuth getBasicAuth()

Authenticate using Username/Password credentials.

.google.cloud.chronicle.v1.UsernameSecretAuth basic_auth = 3;

Returns
Type	Description
UsernameSecretAuth	The basicAuth.

getBasicAuthOrBuilder()

public UsernameSecretAuthOrBuilder getBasicAuthOrBuilder()

Authenticate using Username/Password credentials.

.google.cloud.chronicle.v1.UsernameSecretAuth basic_auth = 3;

Returns
Type	Description
UsernameSecretAuthOrBuilder

getDefaultInstanceForType()

public CustomAPISettings getDefaultInstanceForType()

Returns
Type	Description
CustomAPISettings

getHeaderAuth()

public CustomAPIHeaderAuth getHeaderAuth()

Authenticate using custom API Keys injected into request headers.

.google.cloud.chronicle.v1.CustomAPIHeaderAuth header_auth = 5;

Returns
Type	Description
CustomAPIHeaderAuth	The headerAuth.

getHeaderAuthOrBuilder()

public CustomAPIHeaderAuthOrBuilder getHeaderAuthOrBuilder()

Authenticate using custom API Keys injected into request headers.

.google.cloud.chronicle.v1.CustomAPIHeaderAuth header_auth = 5;

Returns
Type	Description
CustomAPIHeaderAuthOrBuilder

getNoAuth()

public CustomAPINoAuth getNoAuth()

Authenticate without credentials or secrets.

.google.cloud.chronicle.v1.CustomAPINoAuth no_auth = 8;

Returns
Type	Description
CustomAPINoAuth	The noAuth.

getNoAuthOrBuilder()

public CustomAPINoAuthOrBuilder getNoAuthOrBuilder()

Authenticate without credentials or secrets.

.google.cloud.chronicle.v1.CustomAPINoAuth no_auth = 8;

Returns
Type	Description
CustomAPINoAuthOrBuilder

getOauthClientCredentials()

public OAuthClientCredentials getOauthClientCredentials()

Authenticate using OAuth 2.0 Client Credentials Grant flow.

.google.cloud.chronicle.v1.OAuthClientCredentials oauth_client_credentials = 4;

Returns
Type	Description
OAuthClientCredentials	The oauthClientCredentials.

getOauthClientCredentialsOrBuilder()

public OAuthClientCredentialsOrBuilder getOauthClientCredentialsOrBuilder()

Authenticate using OAuth 2.0 Client Credentials Grant flow.

.google.cloud.chronicle.v1.OAuthClientCredentials oauth_client_credentials = 4;

Returns
Type	Description
OAuthClientCredentialsOrBuilder

getParserForType()

public Parser<CustomAPISettings> getParserForType()

Returns
Type	Description
Parser<CustomAPISettings>

Overrides

GeneratedMessage.getParserForType()

getPollingFrequency()

public int getPollingFrequency()

Optional. Specify how often the platform checks the API for new data in minutes (default is 15 minutes).

int32 polling_frequency = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pollingFrequency.

getPrimaryRequest()

public CustomAPITransferNode getPrimaryRequest()

Required. Configure the initial API call used to fetch the main list of logs or events.

.google.cloud.chronicle.v1.CustomAPITransferNode primary_request = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CustomAPITransferNode	The primaryRequest.

getPrimaryRequestOrBuilder()

public CustomAPITransferNodeOrBuilder getPrimaryRequestOrBuilder()

Required. Configure the initial API call used to fetch the main list of logs or events.

.google.cloud.chronicle.v1.CustomAPITransferNode primary_request = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CustomAPITransferNodeOrBuilder

getQueryAuth()

public CustomAPIQueryAuth getQueryAuth()

Authenticate using custom API Keys injected into URL query parameters.

.google.cloud.chronicle.v1.CustomAPIQueryAuth query_auth = 9;

Returns
Type	Description
CustomAPIQueryAuth	The queryAuth.

getQueryAuthOrBuilder()

public CustomAPIQueryAuthOrBuilder getQueryAuthOrBuilder()

Authenticate using custom API Keys injected into URL query parameters.

.google.cloud.chronicle.v1.CustomAPIQueryAuth query_auth = 9;

Returns
Type	Description
CustomAPIQueryAuthOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hasBasicAuth()

public boolean hasBasicAuth()

Authenticate using Username/Password credentials.

.google.cloud.chronicle.v1.UsernameSecretAuth basic_auth = 3;

Returns
Type	Description
boolean	Whether the basicAuth field is set.

hasHeaderAuth()

public boolean hasHeaderAuth()

Authenticate using custom API Keys injected into request headers.

.google.cloud.chronicle.v1.CustomAPIHeaderAuth header_auth = 5;

Returns
Type	Description
boolean	Whether the headerAuth field is set.

hasNoAuth()

public boolean hasNoAuth()

Authenticate without credentials or secrets.

.google.cloud.chronicle.v1.CustomAPINoAuth no_auth = 8;

Returns
Type	Description
boolean	Whether the noAuth field is set.

hasOauthClientCredentials()

public boolean hasOauthClientCredentials()

Authenticate using OAuth 2.0 Client Credentials Grant flow.

.google.cloud.chronicle.v1.OAuthClientCredentials oauth_client_credentials = 4;

Returns
Type	Description
boolean	Whether the oauthClientCredentials field is set.

hasPrimaryRequest()

public boolean hasPrimaryRequest()

Required. Configure the initial API call used to fetch the main list of logs or events.

.google.cloud.chronicle.v1.CustomAPITransferNode primary_request = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the primaryRequest field is set.

hasQueryAuth()

public boolean hasQueryAuth()

Authenticate using custom API Keys injected into URL query parameters.

.google.cloud.chronicle.v1.CustomAPIQueryAuth query_auth = 9;

Returns
Type	Description
boolean	Whether the queryAuth field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public CustomAPISettings.Builder newBuilderForType()

Returns
Type	Description
CustomAPISettings.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CustomAPISettings.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
CustomAPISettings.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public CustomAPISettings.Builder toBuilder()

Returns
Type	Description
CustomAPISettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException