Class IndexConfig (3.17.0)

public final class IndexConfig extends GeneratedMessageV3 implements IndexConfigOrBuilder

Configuration for an indexed field.

Protobuf type google.logging.v2.IndexConfig

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

FIELD_PATH_FIELD_NUMBER

public static final int FIELD_PATH_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IndexConfig getDefaultInstance()
Returns
Type Description
IndexConfig

getDescriptor()

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

newBuilder()

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

newBuilder(IndexConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when the index was last modified.

This is used to return the timestamp, and will be ignored if supplied during update.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the index was last modified.

This is used to return the timestamp, and will be ignored if supplied during update.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public IndexConfig getDefaultInstanceForType()
Returns
Type Description
IndexConfig

getFieldPath()

public String getFieldPath()

Required. The LogEntry field path to index.

Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details.

For example: jsonPayload.request.status

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

Returns
Type Description
String

The fieldPath.

getFieldPathBytes()

public ByteString getFieldPathBytes()

Required. The LogEntry field path to index.

Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details.

For example: jsonPayload.request.status

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

Returns
Type Description
ByteString

The bytes for fieldPath.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public IndexType getType()

Required. The type of data in this index.

.google.logging.v2.IndexType type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IndexType

The type.

getTypeValue()

public int getTypeValue()

Required. The type of data in this index.

.google.logging.v2.IndexType type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for type.

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when the index was last modified.

This is used to return the timestamp, and will be ignored if supplied during update.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IndexConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IndexConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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