Class IndexConfig.Builder (3.24.0)

public static final class IndexConfig.Builder extends GeneratedMessage.Builder<IndexConfig.Builder> implements IndexConfigOrBuilder

Configuration for an indexed field.

Protobuf type google.logging.v2.IndexConfig

Static Methods

getDescriptor()

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

Methods

build()

public IndexConfig build()
Returns
Type Description
IndexConfig

buildPartial()

public IndexConfig buildPartial()
Returns
Type Description
IndexConfig

clear()

public IndexConfig.Builder clear()
Returns
Type Description
IndexConfig.Builder
Overrides

clearCreateTime()

public IndexConfig.Builder clearCreateTime()

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
IndexConfig.Builder

clearFieldPath()

public IndexConfig.Builder clearFieldPath()

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
IndexConfig.Builder

This builder for chaining.

clearType()

public IndexConfig.Builder clearType()

Required. The type of data in this index.

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

Returns
Type Description
IndexConfig.Builder

This builder for chaining.

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public IndexConfig.Builder mergeCreateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
IndexConfig.Builder

mergeFrom(IndexConfig other)

public IndexConfig.Builder mergeFrom(IndexConfig other)
Parameter
Name Description
other IndexConfig
Returns
Type Description
IndexConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public IndexConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public IndexConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
IndexConfig.Builder
Overrides

setCreateTime(Timestamp value)

public IndexConfig.Builder setCreateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
IndexConfig.Builder

setCreateTime(Timestamp.Builder builderForValue)

public IndexConfig.Builder setCreateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
IndexConfig.Builder

setFieldPath(String value)

public IndexConfig.Builder setFieldPath(String value)

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];

Parameter
Name Description
value String

The fieldPath to set.

Returns
Type Description
IndexConfig.Builder

This builder for chaining.

setFieldPathBytes(ByteString value)

public IndexConfig.Builder setFieldPathBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for fieldPath to set.

Returns
Type Description
IndexConfig.Builder

This builder for chaining.

setType(IndexType value)

public IndexConfig.Builder setType(IndexType value)

Required. The type of data in this index.

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

Parameter
Name Description
value IndexType

The type to set.

Returns
Type Description
IndexConfig.Builder

This builder for chaining.

setTypeValue(int value)

public IndexConfig.Builder setTypeValue(int value)

Required. The type of data in this index.

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

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
IndexConfig.Builder

This builder for chaining.