Package com.google.cloud.discoveryengine.v1beta

Class PageInfo.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<PageInfo.Builder>
com.google.cloud.discoveryengine.v1beta.PageInfo.Builder
All Implemented Interfaces:
PageInfoOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
PageInfo
public static final class PageInfo.Builder extends com.google.protobuf.GeneratedMessage.Builder<PageInfo.Builder> implements PageInfoOrBuilder
 Detailed page information.
Protobuf type google.cloud.discoveryengine.v1beta.PageInfo

  • Method Summary

    Modifier and Type
    Method
    Description
    PageInfo
    build()
     
    PageInfo
    buildPartial()
     
    PageInfo.Builder
    clear()
     
    PageInfo.Builder
    clearPageCategory()
    The most specific category associated with a category page.
    PageInfo.Builder
    clearPageviewId()
    A unique ID of a web page view.
    PageInfo.Builder
    clearReferrerUri()
    The referrer URL of the current page.
    PageInfo.Builder
    clearUri()
    Complete URL (window.location.href) of the user's current page.
    PageInfo
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getPageCategory()
    The most specific category associated with a category page.
    com.google.protobuf.ByteString
    getPageCategoryBytes()
    The most specific category associated with a category page.
    String
    getPageviewId()
    A unique ID of a web page view.
    com.google.protobuf.ByteString
    getPageviewIdBytes()
    A unique ID of a web page view.
    String
    getReferrerUri()
    The referrer URL of the current page.
    com.google.protobuf.ByteString
    getReferrerUriBytes()
    The referrer URL of the current page.
    String
    getUri()
    Complete URL (window.location.href) of the user's current page.
    com.google.protobuf.ByteString
    getUriBytes()
    Complete URL (window.location.href) of the user's current page.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    PageInfo.Builder
    mergeFrom(PageInfo other)
     
    PageInfo.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    PageInfo.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    PageInfo.Builder
    setPageCategory(String value)
    The most specific category associated with a category page.
    PageInfo.Builder
    setPageCategoryBytes(com.google.protobuf.ByteString value)
    The most specific category associated with a category page.
    PageInfo.Builder
    setPageviewId(String value)
    A unique ID of a web page view.
    PageInfo.Builder
    setPageviewIdBytes(com.google.protobuf.ByteString value)
    A unique ID of a web page view.
    PageInfo.Builder
    setReferrerUri(String value)
    The referrer URL of the current page.
    PageInfo.Builder
    setReferrerUriBytes(com.google.protobuf.ByteString value)
    The referrer URL of the current page.
    PageInfo.Builder
    setUri(String value)
    Complete URL (window.location.href) of the user's current page.
    PageInfo.Builder
    setUriBytes(com.google.protobuf.ByteString value)
    Complete URL (window.location.href) of the user's current page.

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

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

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

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PageInfo.Builder>

    • clear

      public PageInfo.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.GeneratedMessage.Builder<PageInfo.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.GeneratedMessage.Builder<PageInfo.Builder>

    • getDefaultInstanceForType

      public PageInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public PageInfo build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public PageInfo buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public PageInfo.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<PageInfo.Builder>

    • mergeFrom

      public PageInfo.Builder mergeFrom(PageInfo other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<PageInfo.Builder>

    • mergeFrom

      public PageInfo.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<PageInfo.Builder>
      Throws:
      IOException

    • getPageviewId

      public String getPageviewId()
       A unique ID of a web page view.

 This should be kept the same for all user events triggered from the same
 pageview. For example, an item detail page view could trigger multiple
 events as the user is browsing the page. The `pageview_id` property should
 be kept the same for all these events so that they can be grouped together
 properly.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically.
      string pageview_id = 1;
      Specified by:
      getPageviewId in interface PageInfoOrBuilder
      Returns:
      The pageviewId.

    • getPageviewIdBytes

      public com.google.protobuf.ByteString getPageviewIdBytes()
       A unique ID of a web page view.

 This should be kept the same for all user events triggered from the same
 pageview. For example, an item detail page view could trigger multiple
 events as the user is browsing the page. The `pageview_id` property should
 be kept the same for all these events so that they can be grouped together
 properly.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically.
      string pageview_id = 1;
      Specified by:
      getPageviewIdBytes in interface PageInfoOrBuilder
      Returns:
      The bytes for pageviewId.

    • setPageviewId

      public PageInfo.Builder setPageviewId(String value)
       A unique ID of a web page view.

 This should be kept the same for all user events triggered from the same
 pageview. For example, an item detail page view could trigger multiple
 events as the user is browsing the page. The `pageview_id` property should
 be kept the same for all these events so that they can be grouped together
 properly.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically.
      string pageview_id = 1;
      Parameters:
      value - The pageviewId to set.
      Returns:
      This builder for chaining.

    • clearPageviewId

      public PageInfo.Builder clearPageviewId()
       A unique ID of a web page view.

 This should be kept the same for all user events triggered from the same
 pageview. For example, an item detail page view could trigger multiple
 events as the user is browsing the page. The `pageview_id` property should
 be kept the same for all these events so that they can be grouped together
 properly.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically.
      string pageview_id = 1;
      Returns:
      This builder for chaining.

    • setPageviewIdBytes

      public PageInfo.Builder setPageviewIdBytes(com.google.protobuf.ByteString value)
       A unique ID of a web page view.

 This should be kept the same for all user events triggered from the same
 pageview. For example, an item detail page view could trigger multiple
 events as the user is browsing the page. The `pageview_id` property should
 be kept the same for all these events so that they can be grouped together
 properly.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically.
      string pageview_id = 1;
      Parameters:
      value - The bytes for pageviewId to set.
      Returns:
      This builder for chaining.

    • getPageCategory

      public String getPageCategory()
       The most specific category associated with a category page.

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 `"pageCategory" : "Sales > 2017 Black Friday Deals"`.

 Required for `view-category-page` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string page_category = 2;
      Specified by:
      getPageCategory in interface PageInfoOrBuilder
      Returns:
      The pageCategory.

    • getPageCategoryBytes

      public com.google.protobuf.ByteString getPageCategoryBytes()
       The most specific category associated with a category page.

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 `"pageCategory" : "Sales > 2017 Black Friday Deals"`.

 Required for `view-category-page` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string page_category = 2;
      Specified by:
      getPageCategoryBytes in interface PageInfoOrBuilder
      Returns:
      The bytes for pageCategory.

    • setPageCategory

      public PageInfo.Builder setPageCategory(String value)
       The most specific category associated with a category page.

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 `"pageCategory" : "Sales > 2017 Black Friday Deals"`.

 Required for `view-category-page` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string page_category = 2;
      Parameters:
      value - The pageCategory to set.
      Returns:
      This builder for chaining.

    • clearPageCategory

      public PageInfo.Builder clearPageCategory()
       The most specific category associated with a category page.

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 `"pageCategory" : "Sales > 2017 Black Friday Deals"`.

 Required for `view-category-page` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string page_category = 2;
      Returns:
      This builder for chaining.

    • setPageCategoryBytes

      public PageInfo.Builder setPageCategoryBytes(com.google.protobuf.ByteString value)
       The most specific category associated with a category page.

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 `"pageCategory" : "Sales > 2017 Black Friday Deals"`.

 Required for `view-category-page` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string page_category = 2;
      Parameters:
      value - The bytes for pageCategory to set.
      Returns:
      This builder for chaining.

    • getUri

      public String getUri()
       Complete URL (window.location.href) of the user's current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. Maximum length 5,000
 characters.
      string uri = 3;
      Specified by:
      getUri in interface PageInfoOrBuilder
      Returns:
      The uri.

    • getUriBytes

      public com.google.protobuf.ByteString getUriBytes()
       Complete URL (window.location.href) of the user's current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. Maximum length 5,000
 characters.
      string uri = 3;
      Specified by:
      getUriBytes in interface PageInfoOrBuilder
      Returns:
      The bytes for uri.

    • setUri

      public PageInfo.Builder setUri(String value)
       Complete URL (window.location.href) of the user's current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. Maximum length 5,000
 characters.
      string uri = 3;
      Parameters:
      value - The uri to set.
      Returns:
      This builder for chaining.

    • clearUri

      public PageInfo.Builder clearUri()
       Complete URL (window.location.href) of the user's current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. Maximum length 5,000
 characters.
      string uri = 3;
      Returns:
      This builder for chaining.

    • setUriBytes

      public PageInfo.Builder setUriBytes(com.google.protobuf.ByteString value)
       Complete URL (window.location.href) of the user's current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. Maximum length 5,000
 characters.
      string uri = 3;
      Parameters:
      value - The bytes for uri to set.
      Returns:
      This builder for chaining.

    • getReferrerUri

      public String getReferrerUri()
       The referrer URL of the current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. However, some browser
 privacy restrictions may cause this field to be empty.
      string referrer_uri = 4;
      Specified by:
      getReferrerUri in interface PageInfoOrBuilder
      Returns:
      The referrerUri.

    • getReferrerUriBytes

      public com.google.protobuf.ByteString getReferrerUriBytes()
       The referrer URL of the current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. However, some browser
 privacy restrictions may cause this field to be empty.
      string referrer_uri = 4;
      Specified by:
      getReferrerUriBytes in interface PageInfoOrBuilder
      Returns:
      The bytes for referrerUri.

    • setReferrerUri

      public PageInfo.Builder setReferrerUri(String value)
       The referrer URL of the current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. However, some browser
 privacy restrictions may cause this field to be empty.
      string referrer_uri = 4;
      Parameters:
      value - The referrerUri to set.
      Returns:
      This builder for chaining.

    • clearReferrerUri

      public PageInfo.Builder clearReferrerUri()
       The referrer URL of the current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. However, some browser
 privacy restrictions may cause this field to be empty.
      string referrer_uri = 4;
      Returns:
      This builder for chaining.

    • setReferrerUriBytes

      public PageInfo.Builder setReferrerUriBytes(com.google.protobuf.ByteString value)
       The referrer URL of the current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. However, some browser
 privacy restrictions may cause this field to be empty.
      string referrer_uri = 4;
      Parameters:
      value - The bytes for referrerUri to set.
      Returns:
      This builder for chaining.