java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<GraphAlgebra.Scan.Builder>
    - - com.alibaba.graphscope.gaia.proto.GraphAlgebra.Scan.Builder

所有已实现的接口:: GraphAlgebra.ScanOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

封闭类:: GraphAlgebra.Scan

public static final class GraphAlgebra.Scan.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GraphAlgebra.Scan.Builder>
implements GraphAlgebra.ScanOrBuilder

 Scan is an operator that transforms the source data format (defined by the database)
 into internal data format (defined/used by runtime)

Protobuf type algebra.Scan

方法概要

所有方法静态方法实例方法具体方法
修饰符和类型	方法	说明
`GraphAlgebra.Scan`	`build()`
`GraphAlgebra.Scan`	`buildPartial()`
`GraphAlgebra.Scan.Builder`	`clear()`
`GraphAlgebra.Scan.Builder`	`clearAlias()`	The alias of the item if it is a vertex or edge
`GraphAlgebra.Scan.Builder`	`clearIdxPredicate()`	The optional filtering predicate for the field that have been indexed
`GraphAlgebra.Scan.Builder`	`clearIsCountOnly()`	The flag that indicates SCAN + COUNT
`GraphAlgebra.Scan.Builder`	`clearMetaData()`	`.algebra.MetaData meta_data = 6;`
`GraphAlgebra.Scan.Builder`	`clearParams()`	The required parameters for the scan
`GraphAlgebra.Scan.Builder`	`clearScanOpt()`	`.algebra.Scan.ScanOpt scan_opt = 1;`
`Common.NameOrId`	`getAlias()`	The alias of the item if it is a vertex or edge
`Common.NameOrId.Builder`	`getAliasBuilder()`	The alias of the item if it is a vertex or edge
`Common.NameOrIdOrBuilder`	`getAliasOrBuilder()`	The alias of the item if it is a vertex or edge
`GraphAlgebra.Scan`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`GraphAlgebra.IndexPredicate`	`getIdxPredicate()`	The optional filtering predicate for the field that have been indexed
`GraphAlgebra.IndexPredicate.Builder`	`getIdxPredicateBuilder()`	The optional filtering predicate for the field that have been indexed
`GraphAlgebra.IndexPredicateOrBuilder`	`getIdxPredicateOrBuilder()`	The optional filtering predicate for the field that have been indexed
`boolean`	`getIsCountOnly()`	The flag that indicates SCAN + COUNT
`GraphAlgebra.MetaData`	`getMetaData()`	`.algebra.MetaData meta_data = 6;`
`GraphAlgebra.MetaData.Builder`	`getMetaDataBuilder()`	`.algebra.MetaData meta_data = 6;`
`GraphAlgebra.MetaDataOrBuilder`	`getMetaDataOrBuilder()`	`.algebra.MetaData meta_data = 6;`
`GraphAlgebra.QueryParams`	`getParams()`	The required parameters for the scan
`GraphAlgebra.QueryParams.Builder`	`getParamsBuilder()`	The required parameters for the scan
`GraphAlgebra.QueryParamsOrBuilder`	`getParamsOrBuilder()`	The required parameters for the scan
`GraphAlgebra.Scan.ScanOpt`	`getScanOpt()`	`.algebra.Scan.ScanOpt scan_opt = 1;`
`int`	`getScanOptValue()`	`.algebra.Scan.ScanOpt scan_opt = 1;`
`boolean`	`hasAlias()`	The alias of the item if it is a vertex or edge
`boolean`	`hasIdxPredicate()`	The optional filtering predicate for the field that have been indexed
`boolean`	`hasMetaData()`	`.algebra.MetaData meta_data = 6;`
`boolean`	`hasParams()`	The required parameters for the scan
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`GraphAlgebra.Scan.Builder`	`mergeAlias(Common.NameOrId value)`	The alias of the item if it is a vertex or edge
`GraphAlgebra.Scan.Builder`	`mergeFrom(GraphAlgebra.Scan other)`
`GraphAlgebra.Scan.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`GraphAlgebra.Scan.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`GraphAlgebra.Scan.Builder`	`mergeIdxPredicate(GraphAlgebra.IndexPredicate value)`	The optional filtering predicate for the field that have been indexed
`GraphAlgebra.Scan.Builder`	`mergeMetaData(GraphAlgebra.MetaData value)`	`.algebra.MetaData meta_data = 6;`
`GraphAlgebra.Scan.Builder`	`mergeParams(GraphAlgebra.QueryParams value)`	The required parameters for the scan
`GraphAlgebra.Scan.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`GraphAlgebra.Scan.Builder`	`setAlias(Common.NameOrId value)`	The alias of the item if it is a vertex or edge
`GraphAlgebra.Scan.Builder`	`setAlias(Common.NameOrId.Builder builderForValue)`	The alias of the item if it is a vertex or edge
`GraphAlgebra.Scan.Builder`	`setIdxPredicate(GraphAlgebra.IndexPredicate value)`	The optional filtering predicate for the field that have been indexed
`GraphAlgebra.Scan.Builder`	`setIdxPredicate(GraphAlgebra.IndexPredicate.Builder builderForValue)`	The optional filtering predicate for the field that have been indexed
`GraphAlgebra.Scan.Builder`	`setIsCountOnly(boolean value)`	The flag that indicates SCAN + COUNT
`GraphAlgebra.Scan.Builder`	`setMetaData(GraphAlgebra.MetaData value)`	`.algebra.MetaData meta_data = 6;`
`GraphAlgebra.Scan.Builder`	`setMetaData(GraphAlgebra.MetaData.Builder builderForValue)`	`.algebra.MetaData meta_data = 6;`
`GraphAlgebra.Scan.Builder`	`setParams(GraphAlgebra.QueryParams value)`	The required parameters for the scan
`GraphAlgebra.Scan.Builder`	`setParams(GraphAlgebra.QueryParams.Builder builderForValue)`	The required parameters for the scan
`GraphAlgebra.Scan.Builder`	`setScanOpt(GraphAlgebra.Scan.ScanOpt value)`	`.algebra.Scan.ScanOpt scan_opt = 1;`
`GraphAlgebra.Scan.Builder`	`setScanOptValue(int value)`	`.algebra.Scan.ScanOpt scan_opt = 1;`
`GraphAlgebra.Scan.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

从类继承的方法 com.google.protobuf.GeneratedMessageV3.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

从类继承的方法 com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

从类继承的方法 com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

从接口继承的方法 com.google.protobuf.MessageLite.Builder
mergeFrom

从接口继承的方法 com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

- 方法详细资料
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    指定者:
    
    internalGetFieldAccessorTable 在类中 com.google.protobuf.GeneratedMessageV3.Builder<GraphAlgebra.Scan.Builder>
  - clear
```
public GraphAlgebra.Scan.Builder clear()
```
    指定者:
    
    clear 在接口中 com.google.protobuf.Message.Builder
    
    指定者:
    
    clear 在接口中 com.google.protobuf.MessageLite.Builder
    
    覆盖:
    
    clear 在类中 com.google.protobuf.GeneratedMessageV3.Builder<GraphAlgebra.Scan.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    指定者:
    
    getDescriptorForType 在接口中 com.google.protobuf.Message.Builder
    
    指定者:
    
    getDescriptorForType 在接口中 com.google.protobuf.MessageOrBuilder
    
    覆盖:
    
    getDescriptorForType 在类中 com.google.protobuf.GeneratedMessageV3.Builder<GraphAlgebra.Scan.Builder>
  - getDefaultInstanceForType
```
public GraphAlgebra.Scan getDefaultInstanceForType()
```
    指定者:
    
    getDefaultInstanceForType 在接口中 com.google.protobuf.MessageLiteOrBuilder
    
    指定者:
    
    getDefaultInstanceForType 在接口中 com.google.protobuf.MessageOrBuilder
  - build
```
public GraphAlgebra.Scan build()
```
    指定者:
    
    build 在接口中 com.google.protobuf.Message.Builder
    
    指定者:
    
    build 在接口中 com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public GraphAlgebra.Scan buildPartial()
```
    指定者:
    
    buildPartial 在接口中 com.google.protobuf.Message.Builder
    
    指定者:
    
    buildPartial 在接口中 com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public GraphAlgebra.Scan.Builder mergeFrom(com.google.protobuf.Message other)
```
    指定者:
    
    mergeFrom 在接口中 com.google.protobuf.Message.Builder
    
    覆盖:
    
    mergeFrom 在类中 com.google.protobuf.AbstractMessage.Builder<GraphAlgebra.Scan.Builder>
  - mergeFrom
```
public GraphAlgebra.Scan.Builder mergeFrom(GraphAlgebra.Scan other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    指定者:
    
    isInitialized 在接口中 com.google.protobuf.MessageLiteOrBuilder
    
    覆盖:
    
    isInitialized 在类中 com.google.protobuf.GeneratedMessageV3.Builder<GraphAlgebra.Scan.Builder>
  - mergeFrom
```
public GraphAlgebra.Scan.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
```
    指定者:
    
    mergeFrom 在接口中 com.google.protobuf.Message.Builder
    
    指定者:
    
    mergeFrom 在接口中 com.google.protobuf.MessageLite.Builder
    
    覆盖:
    
    mergeFrom 在类中 com.google.protobuf.AbstractMessage.Builder<GraphAlgebra.Scan.Builder>
    
    抛出:
    
    IOException
  - getScanOptValue
```
public int getScanOptValue()
```
    .algebra.Scan.ScanOpt scan_opt = 1;
    
    指定者:
    
    getScanOptValue 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    The enum numeric value on the wire for scanOpt.
  - setScanOptValue
```
public GraphAlgebra.Scan.Builder setScanOptValue(int value)
```
    .algebra.Scan.ScanOpt scan_opt = 1;
    
    参数:
    
    value - The enum numeric value on the wire for scanOpt to set.
    
    返回:
    
    This builder for chaining.
  - getScanOpt
```
public GraphAlgebra.Scan.ScanOpt getScanOpt()
```
    .algebra.Scan.ScanOpt scan_opt = 1;
    
    指定者:
    
    getScanOpt 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    The scanOpt.
  - setScanOpt
```
public GraphAlgebra.Scan.Builder setScanOpt(GraphAlgebra.Scan.ScanOpt value)
```
    .algebra.Scan.ScanOpt scan_opt = 1;
    
    参数:
    
    value - The scanOpt to set.
    
    返回:
    
    This builder for chaining.
  - clearScanOpt
```
public GraphAlgebra.Scan.Builder clearScanOpt()
```
    .algebra.Scan.ScanOpt scan_opt = 1;
    
    返回:
    
    This builder for chaining.
  - hasAlias
```
public boolean hasAlias()
```
    The alias of the item if it is a vertex or edge
    .common.NameOrId alias = 2;
    指定者:
    
    hasAlias 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    Whether the alias field is set.
  - getAlias
```
public Common.NameOrId getAlias()
```
    The alias of the item if it is a vertex or edge
    .common.NameOrId alias = 2;
    指定者:
    
    getAlias 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    The alias.
  - setAlias
```
public GraphAlgebra.Scan.Builder setAlias(Common.NameOrId value)
```
    The alias of the item if it is a vertex or edge
    .common.NameOrId alias = 2;
  - setAlias
```
public GraphAlgebra.Scan.Builder setAlias(Common.NameOrId.Builder builderForValue)
```
    The alias of the item if it is a vertex or edge
    .common.NameOrId alias = 2;
  - mergeAlias
```
public GraphAlgebra.Scan.Builder mergeAlias(Common.NameOrId value)
```
    The alias of the item if it is a vertex or edge
    .common.NameOrId alias = 2;
  - clearAlias
```
public GraphAlgebra.Scan.Builder clearAlias()
```
    The alias of the item if it is a vertex or edge
    .common.NameOrId alias = 2;
  - getAliasBuilder
```
public Common.NameOrId.Builder getAliasBuilder()
```
    The alias of the item if it is a vertex or edge
    .common.NameOrId alias = 2;
  - getAliasOrBuilder
```
public Common.NameOrIdOrBuilder getAliasOrBuilder()
```
    The alias of the item if it is a vertex or edge
    .common.NameOrId alias = 2;
    指定者:
    
    getAliasOrBuilder 在接口中 GraphAlgebra.ScanOrBuilder
  - hasParams
```
public boolean hasParams()
```
    The required parameters for the scan
    .algebra.QueryParams params = 3;
    指定者:
    
    hasParams 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    Whether the params field is set.
  - getParams
```
public GraphAlgebra.QueryParams getParams()
```
    The required parameters for the scan
    .algebra.QueryParams params = 3;
    指定者:
    
    getParams 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    The params.
  - setParams
```
public GraphAlgebra.Scan.Builder setParams(GraphAlgebra.QueryParams value)
```
    The required parameters for the scan
    .algebra.QueryParams params = 3;
  - setParams
```
public GraphAlgebra.Scan.Builder setParams(GraphAlgebra.QueryParams.Builder builderForValue)
```
    The required parameters for the scan
    .algebra.QueryParams params = 3;
  - mergeParams
```
public GraphAlgebra.Scan.Builder mergeParams(GraphAlgebra.QueryParams value)
```
    The required parameters for the scan
    .algebra.QueryParams params = 3;
  - clearParams
```
public GraphAlgebra.Scan.Builder clearParams()
```
    The required parameters for the scan
    .algebra.QueryParams params = 3;
  - getParamsBuilder
```
public GraphAlgebra.QueryParams.Builder getParamsBuilder()
```
    The required parameters for the scan
    .algebra.QueryParams params = 3;
  - getParamsOrBuilder
```
public GraphAlgebra.QueryParamsOrBuilder getParamsOrBuilder()
```
    The required parameters for the scan
    .algebra.QueryParams params = 3;
    指定者:
    
    getParamsOrBuilder 在接口中 GraphAlgebra.ScanOrBuilder
  - hasIdxPredicate
```
public boolean hasIdxPredicate()
```
    The optional filtering predicate for the field that have been indexed
    .algebra.IndexPredicate idx_predicate = 4;
    指定者:
    
    hasIdxPredicate 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    Whether the idxPredicate field is set.
  - getIdxPredicate
```
public GraphAlgebra.IndexPredicate getIdxPredicate()
```
    The optional filtering predicate for the field that have been indexed
    .algebra.IndexPredicate idx_predicate = 4;
    指定者:
    
    getIdxPredicate 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    The idxPredicate.
  - setIdxPredicate
```
public GraphAlgebra.Scan.Builder setIdxPredicate(GraphAlgebra.IndexPredicate value)
```
    The optional filtering predicate for the field that have been indexed
    .algebra.IndexPredicate idx_predicate = 4;
  - setIdxPredicate
```
public GraphAlgebra.Scan.Builder setIdxPredicate(GraphAlgebra.IndexPredicate.Builder builderForValue)
```
    The optional filtering predicate for the field that have been indexed
    .algebra.IndexPredicate idx_predicate = 4;
  - mergeIdxPredicate
```
public GraphAlgebra.Scan.Builder mergeIdxPredicate(GraphAlgebra.IndexPredicate value)
```
    The optional filtering predicate for the field that have been indexed
    .algebra.IndexPredicate idx_predicate = 4;
  - clearIdxPredicate
```
public GraphAlgebra.Scan.Builder clearIdxPredicate()
```
    The optional filtering predicate for the field that have been indexed
    .algebra.IndexPredicate idx_predicate = 4;
  - getIdxPredicateBuilder
```
public GraphAlgebra.IndexPredicate.Builder getIdxPredicateBuilder()
```
    The optional filtering predicate for the field that have been indexed
    .algebra.IndexPredicate idx_predicate = 4;
  - getIdxPredicateOrBuilder
```
public GraphAlgebra.IndexPredicateOrBuilder getIdxPredicateOrBuilder()
```
    The optional filtering predicate for the field that have been indexed
    .algebra.IndexPredicate idx_predicate = 4;
    指定者:
    
    getIdxPredicateOrBuilder 在接口中 GraphAlgebra.ScanOrBuilder
  - getIsCountOnly
```
public boolean getIsCountOnly()
```
    The flag that indicates SCAN + COUNT
    bool is_count_only = 5;
    指定者:
    
    getIsCountOnly 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    The isCountOnly.
  - setIsCountOnly
```
public GraphAlgebra.Scan.Builder setIsCountOnly(boolean value)
```
    The flag that indicates SCAN + COUNT
    bool is_count_only = 5;
    参数:
    
    value - The isCountOnly to set.
    
    返回:
    
    This builder for chaining.
  - clearIsCountOnly
```
public GraphAlgebra.Scan.Builder clearIsCountOnly()
```
    The flag that indicates SCAN + COUNT
    bool is_count_only = 5;
    返回:
    
    This builder for chaining.
  - hasMetaData
```
public boolean hasMetaData()
```
    .algebra.MetaData meta_data = 6;
    
    指定者:
    
    hasMetaData 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    Whether the metaData field is set.
  - getMetaData
```
public GraphAlgebra.MetaData getMetaData()
```
    .algebra.MetaData meta_data = 6;
    
    指定者:
    
    getMetaData 在接口中 GraphAlgebra.ScanOrBuilder
    
    返回:
    
    The metaData.
  - setMetaData
```
public GraphAlgebra.Scan.Builder setMetaData(GraphAlgebra.MetaData value)
```
    .algebra.MetaData meta_data = 6;
  - setMetaData
```
public GraphAlgebra.Scan.Builder setMetaData(GraphAlgebra.MetaData.Builder builderForValue)
```
    .algebra.MetaData meta_data = 6;
  - mergeMetaData
```
public GraphAlgebra.Scan.Builder mergeMetaData(GraphAlgebra.MetaData value)
```
    .algebra.MetaData meta_data = 6;
  - clearMetaData
```
public GraphAlgebra.Scan.Builder clearMetaData()
```
    .algebra.MetaData meta_data = 6;
  - getMetaDataBuilder
```
public GraphAlgebra.MetaData.Builder getMetaDataBuilder()
```
    .algebra.MetaData meta_data = 6;
  - getMetaDataOrBuilder
```
public GraphAlgebra.MetaDataOrBuilder getMetaDataOrBuilder()
```
    .algebra.MetaData meta_data = 6;
    
    指定者:
    
    getMetaDataOrBuilder 在接口中 GraphAlgebra.ScanOrBuilder
  - setUnknownFields
```
public final GraphAlgebra.Scan.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    指定者:
    
    setUnknownFields 在接口中 com.google.protobuf.Message.Builder
    
    覆盖:
    
    setUnknownFields 在类中 com.google.protobuf.GeneratedMessageV3.Builder<GraphAlgebra.Scan.Builder>
  - mergeUnknownFields
```
public final GraphAlgebra.Scan.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    指定者:
    
    mergeUnknownFields 在接口中 com.google.protobuf.Message.Builder
    
    覆盖:
    
    mergeUnknownFields 在类中 com.google.protobuf.GeneratedMessageV3.Builder<GraphAlgebra.Scan.Builder>

类 GraphAlgebra.Scan.Builder

方法概要

从类继承的方法 com.google.protobuf.GeneratedMessageV3.Builder

从类继承的方法 com.google.protobuf.AbstractMessage.Builder

从类继承的方法 com.google.protobuf.AbstractMessageLite.Builder

从类继承的方法 java.lang.Object

从接口继承的方法 com.google.protobuf.Message.Builder

从接口继承的方法 com.google.protobuf.MessageLite.Builder

从接口继承的方法 com.google.protobuf.MessageOrBuilder

方法详细资料

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getScanOptValue

setScanOptValue

getScanOpt

setScanOpt

clearScanOpt

hasAlias

getAlias

setAlias

setAlias

mergeAlias

clearAlias

getAliasBuilder

getAliasOrBuilder

hasParams

getParams

setParams

setParams

mergeParams

clearParams

getParamsBuilder

getParamsOrBuilder

hasIdxPredicate

getIdxPredicate

setIdxPredicate

setIdxPredicate

mergeIdxPredicate

clearIdxPredicate

getIdxPredicateBuilder

getIdxPredicateOrBuilder

getIsCountOnly

setIsCountOnly

clearIsCountOnly

hasMetaData

getMetaData

setMetaData

setMetaData

mergeMetaData

clearMetaData

getMetaDataBuilder

getMetaDataOrBuilder

setUnknownFields

mergeUnknownFields