Package com.google.cloud.discoveryengine.v1

Interface SearchLinkPromotionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchLinkPromotion, SearchLinkPromotion.Builder
@Generated public interface SearchLinkPromotionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Optional.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Optional.
    String
    getDocument()
    Optional.
    com.google.protobuf.ByteString
    getDocumentBytes()
    Optional.
    boolean
    getEnabled()
    Optional.
    String
    getImageUri()
    Optional.
    com.google.protobuf.ByteString
    getImageUriBytes()
    Optional.
    String
    getTitle()
    Required.
    com.google.protobuf.ByteString
    getTitleBytes()
    Required.
    String
    getUri()
    Optional.
    com.google.protobuf.ByteString
    getUriBytes()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getTitle

      String getTitle()
       Required. The title of the promotion.
 Maximum length: 160 characters.
      string title = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The title.

    • getTitleBytes

      com.google.protobuf.ByteString getTitleBytes()
       Required. The title of the promotion.
 Maximum length: 160 characters.
      string title = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for title.

    • getUri

      String getUri()
       Optional. The URL for the page the user wants to promote. Must be set for
 site search. For other verticals, this is optional.
      string uri = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The uri.

    • getUriBytes

      com.google.protobuf.ByteString getUriBytes()
       Optional. The URL for the page the user wants to promote. Must be set for
 site search. For other verticals, this is optional.
      string uri = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for uri.

    • getDocument

      String getDocument()
       Optional. The [Document][google.cloud.discoveryengine.v1.Document] the user
 wants to promote. For site search, leave unset and only populate uri. Can
 be set along with uri.
      string document = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The document.

    • getDocumentBytes

      com.google.protobuf.ByteString getDocumentBytes()
       Optional. The [Document][google.cloud.discoveryengine.v1.Document] the user
 wants to promote. For site search, leave unset and only populate uri. Can
 be set along with uri.
      string document = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for document.

    • getImageUri

      String getImageUri()
       Optional. The promotion thumbnail image url.
      string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The imageUri.

    • getImageUriBytes

      com.google.protobuf.ByteString getImageUriBytes()
       Optional. The promotion thumbnail image url.
      string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for imageUri.

    • getDescription

      String getDescription()
       Optional. The Promotion description.
 Maximum length: 200 characters.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The Promotion description.
 Maximum length: 200 characters.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getEnabled

      boolean getEnabled()
       Optional. The enabled promotion will be returned for any serving configs
 associated with the parent of the control this promotion is attached to.

 This flag is used for basic site search only.
      bool enabled = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enabled.