Document.PageAnchor.PageRef.Builder (proto-google-cloud-document-ai-v1beta2 0.3.6 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
    - - com.google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.Builder

All Implemented Interfaces:

Document.PageAnchor.PageRefOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Document.PageAnchor.PageRef
```
public static final class Document.PageAnchor.PageRef.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
implements Document.PageAnchor.PageRefOrBuilder
```
```
 Represents a weak reference to a page element within a document.
 
```
Protobuf type google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Document.PageAnchor.PageRef.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Document.PageAnchor.PageRef`	`build()`
`Document.PageAnchor.PageRef`	`buildPartial()`
`Document.PageAnchor.PageRef.Builder`	`clear()`
`Document.PageAnchor.PageRef.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Document.PageAnchor.PageRef.Builder`	`clearLayoutId()` Optional.
`Document.PageAnchor.PageRef.Builder`	`clearLayoutType()` Optional.
`Document.PageAnchor.PageRef.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Document.PageAnchor.PageRef.Builder`	`clearPage()` Required.
`Document.PageAnchor.PageRef.Builder`	`clone()`
`Document.PageAnchor.PageRef`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getLayoutId()` Optional.
`com.google.protobuf.ByteString`	`getLayoutIdBytes()` Optional.
`Document.PageAnchor.PageRef.LayoutType`	`getLayoutType()` Optional.
`int`	`getLayoutTypeValue()` Optional.
`long`	`getPage()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Document.PageAnchor.PageRef.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Document.PageAnchor.PageRef.Builder`	`mergeFrom(Document.PageAnchor.PageRef other)`
`Document.PageAnchor.PageRef.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Document.PageAnchor.PageRef.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Document.PageAnchor.PageRef.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Document.PageAnchor.PageRef.Builder`	`setLayoutId(String value)` Optional.
`Document.PageAnchor.PageRef.Builder`	`setLayoutIdBytes(com.google.protobuf.ByteString value)` Optional.
`Document.PageAnchor.PageRef.Builder`	`setLayoutType(Document.PageAnchor.PageRef.LayoutType value)` Optional.
`Document.PageAnchor.PageRef.Builder`	`setLayoutTypeValue(int value)` Optional.
`Document.PageAnchor.PageRef.Builder`	`setPage(long value)` Required.
`Document.PageAnchor.PageRef.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Document.PageAnchor.PageRef.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - clear
```
public Document.PageAnchor.PageRef.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - getDefaultInstanceForType
```
public Document.PageAnchor.PageRef getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Document.PageAnchor.PageRef build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Document.PageAnchor.PageRef buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Document.PageAnchor.PageRef.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - setField
```
public Document.PageAnchor.PageRef.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - clearField
```
public Document.PageAnchor.PageRef.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - clearOneof
```
public Document.PageAnchor.PageRef.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - setRepeatedField
```
public Document.PageAnchor.PageRef.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                            int index,
                                                            Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - addRepeatedField
```
public Document.PageAnchor.PageRef.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                            Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - mergeFrom
```
public Document.PageAnchor.PageRef.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.PageAnchor.PageRef.Builder>
  - mergeFrom
```
public Document.PageAnchor.PageRef.Builder mergeFrom(Document.PageAnchor.PageRef other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - mergeFrom
```
public Document.PageAnchor.PageRef.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.PageAnchor.PageRef.Builder>
    
    Throws:
    
    IOException
  - getPage
```
public long getPage()
```
```
 Required. Index into the [Document.pages][google.cloud.documentai.v1beta2.Document.pages] element
 
```
    int64 page = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getPage in interface Document.PageAnchor.PageRefOrBuilder
    
    Returns:
    
    The page.
  - setPage
```
public Document.PageAnchor.PageRef.Builder setPage(long value)
```
```
 Required. Index into the [Document.pages][google.cloud.documentai.v1beta2.Document.pages] element
 
```
    int64 page = 1 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The page to set.
    
    Returns:
    
    This builder for chaining.
  - clearPage
```
public Document.PageAnchor.PageRef.Builder clearPage()
```
```
 Required. Index into the [Document.pages][google.cloud.documentai.v1beta2.Document.pages] element
 
```
    int64 page = 1 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    This builder for chaining.
  - getLayoutTypeValue
```
public int getLayoutTypeValue()
```
```
 Optional. The type of the layout element that is being referenced.  If not
 specified the whole page is assumed to be referenced.
 
```
    .google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getLayoutTypeValue in interface Document.PageAnchor.PageRefOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for layoutType.
  - setLayoutTypeValue
```
public Document.PageAnchor.PageRef.Builder setLayoutTypeValue(int value)
```
```
 Optional. The type of the layout element that is being referenced.  If not
 specified the whole page is assumed to be referenced.
 
```
    .google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The enum numeric value on the wire for layoutType to set.
    
    Returns:
    
    This builder for chaining.
  - getLayoutType
```
public Document.PageAnchor.PageRef.LayoutType getLayoutType()
```
```
 Optional. The type of the layout element that is being referenced.  If not
 specified the whole page is assumed to be referenced.
 
```
    .google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getLayoutType in interface Document.PageAnchor.PageRefOrBuilder
    
    Returns:
    
    The layoutType.
  - setLayoutType
```
public Document.PageAnchor.PageRef.Builder setLayoutType(Document.PageAnchor.PageRef.LayoutType value)
```
```
 Optional. The type of the layout element that is being referenced.  If not
 specified the whole page is assumed to be referenced.
 
```
    .google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The layoutType to set.
    
    Returns:
    
    This builder for chaining.
  - clearLayoutType
```
public Document.PageAnchor.PageRef.Builder clearLayoutType()
```
```
 Optional. The type of the layout element that is being referenced.  If not
 specified the whole page is assumed to be referenced.
 
```
    .google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - getLayoutId
```
public String getLayoutId()
```
```
 Optional. The [Page.Layout.id][google.cloud.documentai.v1beta2.Document.Page.Layout.id] on the page that this element
 references.  If [LayoutRef.type][] is specified this id must also be
 specified.
 
```
    string layout_id = 3 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getLayoutId in interface Document.PageAnchor.PageRefOrBuilder
    
    Returns:
    
    The layoutId.
  - getLayoutIdBytes
```
public com.google.protobuf.ByteString getLayoutIdBytes()
```
```
 Optional. The [Page.Layout.id][google.cloud.documentai.v1beta2.Document.Page.Layout.id] on the page that this element
 references.  If [LayoutRef.type][] is specified this id must also be
 specified.
 
```
    string layout_id = 3 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getLayoutIdBytes in interface Document.PageAnchor.PageRefOrBuilder
    
    Returns:
    
    The bytes for layoutId.
  - setLayoutId
```
public Document.PageAnchor.PageRef.Builder setLayoutId(String value)
```
```
 Optional. The [Page.Layout.id][google.cloud.documentai.v1beta2.Document.Page.Layout.id] on the page that this element
 references.  If [LayoutRef.type][] is specified this id must also be
 specified.
 
```
    string layout_id = 3 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The layoutId to set.
    
    Returns:
    
    This builder for chaining.
  - clearLayoutId
```
public Document.PageAnchor.PageRef.Builder clearLayoutId()
```
```
 Optional. The [Page.Layout.id][google.cloud.documentai.v1beta2.Document.Page.Layout.id] on the page that this element
 references.  If [LayoutRef.type][] is specified this id must also be
 specified.
 
```
    string layout_id = 3 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - setLayoutIdBytes
```
public Document.PageAnchor.PageRef.Builder setLayoutIdBytes(com.google.protobuf.ByteString value)
```
```
 Optional. The [Page.Layout.id][google.cloud.documentai.v1beta2.Document.Page.Layout.id] on the page that this element
 references.  If [LayoutRef.type][] is specified this id must also be
 specified.
 
```
    string layout_id = 3 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The bytes for layoutId to set.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final Document.PageAnchor.PageRef.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>
  - mergeUnknownFields
```
public final Document.PageAnchor.PageRef.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder>

Class Document.PageAnchor.PageRef.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getPage

setPage

clearPage

getLayoutTypeValue

setLayoutTypeValue

getLayoutType

setLayoutType

clearLayoutType

getLayoutId

getLayoutIdBytes

setLayoutId

clearLayoutId

setLayoutIdBytes

setUnknownFields

mergeUnknownFields