Package com.google.cloud.documentai.v1

Class Document.PageAnchor.PageRef.Builder

    • 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>

      • 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

      • 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.v1.Document.pages] element,
 for example using
 `[Document.pages][page_refs.page]` to locate the related page element.
 This field is skipped when its value is the default `0`. See
 https://developers.google.com/protocol-buffers/docs/proto3#json.
        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.v1.Document.pages] element,
 for example using
 `[Document.pages][page_refs.page]` to locate the related page element.
 This field is skipped when its value is the default `0`. See
 https://developers.google.com/protocol-buffers/docs/proto3#json.
        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.v1.Document.pages] element,
 for example using
 `[Document.pages][page_refs.page]` to locate the related page element.
 This field is skipped when its value is the default `0`. See
 https://developers.google.com/protocol-buffers/docs/proto3#json.
        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
 any.
        .google.cloud.documentai.v1.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
 any.
        .google.cloud.documentai.v1.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.

      • setLayoutType

        public Document.PageAnchor.PageRef.Builder setLayoutType​(Document.PageAnchor.PageRef.LayoutType value)
         Optional. The type of the layout element that is being referenced if
 any.
        .google.cloud.documentai.v1.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
 any.
        .google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getLayoutId

        @Deprecated
public String getLayoutId()
        Deprecated.
        google.cloud.documentai.v1.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1/document.proto;l=752
         Optional. Deprecated.  Use
 [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly]
 instead.
        string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLayoutId in interface Document.PageAnchor.PageRefOrBuilder
        Returns:
        The layoutId.

      • getLayoutIdBytes

        @Deprecated
public com.google.protobuf.ByteString getLayoutIdBytes()
        Deprecated.
        google.cloud.documentai.v1.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1/document.proto;l=752
         Optional. Deprecated.  Use
 [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly]
 instead.
        string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLayoutIdBytes in interface Document.PageAnchor.PageRefOrBuilder
        Returns:
        The bytes for layoutId.

      • setLayoutId

        @Deprecated
public Document.PageAnchor.PageRef.Builder setLayoutId​(String value)
        Deprecated.
        google.cloud.documentai.v1.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1/document.proto;l=752
         Optional. Deprecated.  Use
 [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly]
 instead.
        string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The layoutId to set.
        Returns:
        This builder for chaining.

      • clearLayoutId

        @Deprecated
public Document.PageAnchor.PageRef.Builder clearLayoutId()
        Deprecated.
        google.cloud.documentai.v1.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1/document.proto;l=752
         Optional. Deprecated.  Use
 [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly]
 instead.
        string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setLayoutIdBytes

        @Deprecated
public Document.PageAnchor.PageRef.Builder setLayoutIdBytes​(com.google.protobuf.ByteString value)
        Deprecated.
        google.cloud.documentai.v1.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1/document.proto;l=752
         Optional. Deprecated.  Use
 [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly]
 instead.
        string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for layoutId to set.
        Returns:
        This builder for chaining.

      • hasBoundingPoly

        public boolean hasBoundingPoly()
         Optional. Identifies the bounding polygon of a layout element on the
 page.
        .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasBoundingPoly in interface Document.PageAnchor.PageRefOrBuilder
        Returns:
        Whether the boundingPoly field is set.

      • getBoundingPoly

        public BoundingPoly getBoundingPoly()
         Optional. Identifies the bounding polygon of a layout element on the
 page.
        .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBoundingPoly in interface Document.PageAnchor.PageRefOrBuilder
        Returns:
        The boundingPoly.

      • setBoundingPoly

        public Document.PageAnchor.PageRef.Builder setBoundingPoly​(BoundingPoly value)
         Optional. Identifies the bounding polygon of a layout element on the
 page.
        .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

      • setBoundingPoly

        public Document.PageAnchor.PageRef.Builder setBoundingPoly​(BoundingPoly.Builder builderForValue)
         Optional. Identifies the bounding polygon of a layout element on the
 page.
        .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

      • mergeBoundingPoly

        public Document.PageAnchor.PageRef.Builder mergeBoundingPoly​(BoundingPoly value)
         Optional. Identifies the bounding polygon of a layout element on the
 page.
        .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

      • clearBoundingPoly

        public Document.PageAnchor.PageRef.Builder clearBoundingPoly()
         Optional. Identifies the bounding polygon of a layout element on the
 page.
        .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getBoundingPolyBuilder

        public BoundingPoly.Builder getBoundingPolyBuilder()
         Optional. Identifies the bounding polygon of a layout element on the
 page.
        .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getConfidence

        public float getConfidence()
         Optional. Confidence of detected page element, if applicable. Range
 `[0, 1]`.
        float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getConfidence in interface Document.PageAnchor.PageRefOrBuilder
        Returns:
        The confidence.

      • setConfidence

        public Document.PageAnchor.PageRef.Builder setConfidence​(float value)
         Optional. Confidence of detected page element, if applicable. Range
 `[0, 1]`.
        float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The confidence to set.
        Returns:
        This builder for chaining.

      • clearConfidence

        public Document.PageAnchor.PageRef.Builder clearConfidence()
         Optional. Confidence of detected page element, if applicable. Range
 `[0, 1]`.
        float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • 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>