Class SearchLinkPromotion (0.71.0)
Version 0.71.0keyboard_arrow_down
public final class SearchLinkPromotion extends GeneratedMessageV3 implements SearchLinkPromotionOrBuilder
Promotion proto includes uri and other helping information to display the
promotion.
Protobuf type google.cloud.discoveryengine.v1.SearchLinkPromotion
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int
public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int
public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int
public static final int IMAGE_URI_FIELD_NUMBER
Field Value
Type Description
int
public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int
public static final int URI_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static SearchLinkPromotion getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static SearchLinkPromotion . Builder newBuilder ()
public static SearchLinkPromotion . Builder newBuilder ( SearchLinkPromotion prototype )
public static SearchLinkPromotion parseDelimitedFrom ( InputStream input )
public static SearchLinkPromotion parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static SearchLinkPromotion parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static SearchLinkPromotion parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static SearchLinkPromotion parseFrom ( ByteString data )
public static SearchLinkPromotion parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static SearchLinkPromotion parseFrom ( CodedInputStream input )
public static SearchLinkPromotion parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static SearchLinkPromotion parseFrom ( InputStream input )
public static SearchLinkPromotion parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static SearchLinkPromotion parseFrom ( ByteBuffer data )
public static SearchLinkPromotion parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<SearchLinkPromotion> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public SearchLinkPromotion getDefaultInstanceForType ()
public String getDescription ()
Optional. The Promotion description.
Maximum length: 200 characters.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The description.
public ByteString getDescriptionBytes ()
Optional. The Promotion description.
Maximum length: 200 characters.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for description.
public String getDocument ()
Optional. The 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
Type Description
String The document.
public ByteString getDocumentBytes ()
Optional. The 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
Type Description
ByteString The bytes for document.
public 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
Type Description
boolean The enabled.
public String getImageUri ()
Optional. The promotion thumbnail image url.
string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The imageUri.
public ByteString getImageUriBytes ()
Optional. The promotion thumbnail image url.
string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for imageUri.
public Parser<SearchLinkPromotion> getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
Overrides
Required. The title of the promotion.
Maximum length: 160 characters.
string title = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The title.
public ByteString getTitleBytes ()
Required. The title of the promotion.
Maximum length: 160 characters.
string title = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for title.
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
Type Description
String The uri.
public 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
Type Description
ByteString The bytes for uri.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public SearchLinkPromotion . Builder newBuilderForType ()
protected SearchLinkPromotion . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public SearchLinkPromotion . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
