Class Index.Builder (2.20.1)

public static final class Index.Builder extends GeneratedMessageV3.Builder<Index.Builder> implements IndexOrBuilder

Datastore composite index definition.

Protobuf type google.datastore.admin.v1.Index

Implements

IndexOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllProperties(Iterable<? extends Index.IndexedProperty> values)

public Index.Builder addAllProperties(Iterable<? extends Index.IndexedProperty> values)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.datastore.admin.v1.Index.IndexedProperty>
Returns
Type Description
Index.Builder

addProperties(Index.IndexedProperty value)

public Index.Builder addProperties(Index.IndexedProperty value)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Index.IndexedProperty
Returns
Type Description
Index.Builder

addProperties(Index.IndexedProperty.Builder builderForValue)

public Index.Builder addProperties(Index.IndexedProperty.Builder builderForValue)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Index.IndexedProperty.Builder
Returns
Type Description
Index.Builder

addProperties(int index, Index.IndexedProperty value)

public Index.Builder addProperties(int index, Index.IndexedProperty value)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value Index.IndexedProperty
Returns
Type Description
Index.Builder

addProperties(int index, Index.IndexedProperty.Builder builderForValue)

public Index.Builder addProperties(int index, Index.IndexedProperty.Builder builderForValue)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue Index.IndexedProperty.Builder
Returns
Type Description
Index.Builder

addPropertiesBuilder()

public Index.IndexedProperty.Builder addPropertiesBuilder()

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Index.IndexedProperty.Builder

addPropertiesBuilder(int index)

public Index.IndexedProperty.Builder addPropertiesBuilder(int index)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Index.IndexedProperty.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Index.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Index.Builder
Overrides

build()

public Index build()
Returns
Type Description
Index

buildPartial()

public Index buildPartial()
Returns
Type Description
Index

clear()

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

clearAncestor()

public Index.Builder clearAncestor()

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

.google.datastore.admin.v1.Index.AncestorMode ancestor = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Index.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Index.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Index.Builder
Overrides

clearIndexId()

public Index.Builder clearIndexId()

Output only. The resource ID of the index.

string index_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Index.Builder

This builder for chaining.

clearKind()

public Index.Builder clearKind()

Required. The entity kind to which this index applies.

string kind = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Index.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Index.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Index.Builder
Overrides

clearProjectId()

public Index.Builder clearProjectId()

Output only. Project ID.

string project_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Index.Builder

This builder for chaining.

clearProperties()

public Index.Builder clearProperties()

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Index.Builder

clearState()

public Index.Builder clearState()

Output only. The state of the index.

.google.datastore.admin.v1.Index.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Index.Builder

This builder for chaining.

clone()

public Index.Builder clone()
Returns
Type Description
Index.Builder
Overrides

getAncestor()

public Index.AncestorMode getAncestor()

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

.google.datastore.admin.v1.Index.AncestorMode ancestor = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Index.AncestorMode

The ancestor.

getAncestorValue()

public int getAncestorValue()

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

.google.datastore.admin.v1.Index.AncestorMode ancestor = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for ancestor.

getDefaultInstanceForType()

public Index getDefaultInstanceForType()
Returns
Type Description
Index

getDescriptorForType()

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

getIndexId()

public String getIndexId()

Output only. The resource ID of the index.

string index_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The indexId.

getIndexIdBytes()

public ByteString getIndexIdBytes()

Output only. The resource ID of the index.

string index_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for indexId.

getKind()

public String getKind()

Required. The entity kind to which this index applies.

string kind = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

Required. The entity kind to which this index applies.

string kind = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for kind.

getProjectId()

public String getProjectId()

Output only. Project ID.

string project_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Output only. Project ID.

string project_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for projectId.

getProperties(int index)

public Index.IndexedProperty getProperties(int index)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Index.IndexedProperty

getPropertiesBuilder(int index)

public Index.IndexedProperty.Builder getPropertiesBuilder(int index)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Index.IndexedProperty.Builder

getPropertiesBuilderList()

public List<Index.IndexedProperty.Builder> getPropertiesBuilderList()

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getPropertiesCount()

public int getPropertiesCount()

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getPropertiesList()

public List<Index.IndexedProperty> getPropertiesList()

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<IndexedProperty>

getPropertiesOrBuilder(int index)

public Index.IndexedPropertyOrBuilder getPropertiesOrBuilder(int index)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Index.IndexedPropertyOrBuilder

getPropertiesOrBuilderList()

public List<? extends Index.IndexedPropertyOrBuilder> getPropertiesOrBuilderList()

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.datastore.admin.v1.Index.IndexedPropertyOrBuilder>

getState()

public Index.State getState()

Output only. The state of the index.

.google.datastore.admin.v1.Index.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Index.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the index.

.google.datastore.admin.v1.Index.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Index other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Index.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Index.Builder
Overrides

removeProperties(int index)

public Index.Builder removeProperties(int index)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Index.Builder

setAncestor(Index.AncestorMode value)

public Index.Builder setAncestor(Index.AncestorMode value)

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

.google.datastore.admin.v1.Index.AncestorMode ancestor = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Index.AncestorMode

The ancestor to set.

Returns
Type Description
Index.Builder

This builder for chaining.

setAncestorValue(int value)

public Index.Builder setAncestorValue(int value)

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

.google.datastore.admin.v1.Index.AncestorMode ancestor = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

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

Returns
Type Description
Index.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Index.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Index.Builder
Overrides

setIndexId(String value)

public Index.Builder setIndexId(String value)

Output only. The resource ID of the index.

string index_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The indexId to set.

Returns
Type Description
Index.Builder

This builder for chaining.

setIndexIdBytes(ByteString value)

public Index.Builder setIndexIdBytes(ByteString value)

Output only. The resource ID of the index.

string index_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for indexId to set.

Returns
Type Description
Index.Builder

This builder for chaining.

setKind(String value)

public Index.Builder setKind(String value)

Required. The entity kind to which this index applies.

string kind = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The kind to set.

Returns
Type Description
Index.Builder

This builder for chaining.

setKindBytes(ByteString value)

public Index.Builder setKindBytes(ByteString value)

Required. The entity kind to which this index applies.

string kind = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for kind to set.

Returns
Type Description
Index.Builder

This builder for chaining.

setProjectId(String value)

public Index.Builder setProjectId(String value)

Output only. Project ID.

string project_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
Index.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public Index.Builder setProjectIdBytes(ByteString value)

Output only. Project ID.

string project_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
Index.Builder

This builder for chaining.

setProperties(int index, Index.IndexedProperty value)

public Index.Builder setProperties(int index, Index.IndexedProperty value)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value Index.IndexedProperty
Returns
Type Description
Index.Builder

setProperties(int index, Index.IndexedProperty.Builder builderForValue)

public Index.Builder setProperties(int index, Index.IndexedProperty.Builder builderForValue)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue Index.IndexedProperty.Builder
Returns
Type Description
Index.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Index.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Index.Builder
Overrides

setState(Index.State value)

public Index.Builder setState(Index.State value)

Output only. The state of the index.

.google.datastore.admin.v1.Index.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Index.State

The state to set.

Returns
Type Description
Index.Builder

This builder for chaining.

setStateValue(int value)

public Index.Builder setStateValue(int value)

Output only. The state of the index.

.google.datastore.admin.v1.Index.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

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

Returns
Type Description
Index.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Index.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Index.Builder
Overrides