Class IndexConfig (3.16.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
TypeDescription
int

FIELD_PATH_FIELD_NUMBER

public static final int FIELD_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static IndexConfig getDefaultInstance()
Returns
TypeDescription
IndexConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static IndexConfig.Builder newBuilder()
Returns
TypeDescription
IndexConfig.Builder

newBuilder(IndexConfig prototype)

public static IndexConfig.Builder newBuilder(IndexConfig prototype)
Parameter
NameDescription
prototypeIndexConfig
Returns
TypeDescription
IndexConfig.Builder

parseDelimitedFrom(InputStream input)

public static IndexConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static IndexConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IndexConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IndexConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IndexConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IndexConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static IndexConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static IndexConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IndexConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<IndexConfig> parser()
Returns
TypeDescription
Parser<IndexConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public IndexConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for fieldPath.

getParserForType()

public Parser<IndexConfig> getParserForType()
Returns
TypeDescription
Parser<IndexConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the createTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public IndexConfig.Builder newBuilderForType()
Returns
TypeDescription
IndexConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IndexConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
IndexConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public IndexConfig.Builder toBuilder()
Returns
TypeDescription
IndexConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException