Class SearchLinkPromotion (0.58.0)

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

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_URI_FIELD_NUMBER

public static final int IMAGE_URI_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchLinkPromotion getDefaultInstance()
Returns
Type Description
SearchLinkPromotion

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchLinkPromotion.Builder newBuilder()
Returns
Type Description
SearchLinkPromotion.Builder

newBuilder(SearchLinkPromotion prototype)

public static SearchLinkPromotion.Builder newBuilder(SearchLinkPromotion prototype)
Parameter
Name Description
prototype SearchLinkPromotion
Returns
Type Description
SearchLinkPromotion.Builder

parseDelimitedFrom(InputStream input)

public static SearchLinkPromotion parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchLinkPromotion parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchLinkPromotion parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchLinkPromotion parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchLinkPromotion parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchLinkPromotion parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchLinkPromotion parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchLinkPromotion parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchLinkPromotion parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchLinkPromotion parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchLinkPromotion parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchLinkPromotion parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchLinkPromotion
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchLinkPromotion> parser()
Returns
Type Description
Parser<SearchLinkPromotion>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchLinkPromotion getDefaultInstanceForType()
Returns
Type Description
SearchLinkPromotion

getDescription()

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.

getDescriptionBytes()

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.

getEnabled()

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.

getImageUri()

public String getImageUri()

Optional. The promotion thumbnail image url.

string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The imageUri.

getImageUriBytes()

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.

getParserForType()

public Parser<SearchLinkPromotion> getParserForType()
Returns
Type Description
Parser<SearchLinkPromotion>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTitle()

public String getTitle()

Required. The title of the promotion. Maximum length: 160 characters.

string title = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The title.

getTitleBytes()

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.

getUri()

public 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
Type Description
String

The uri.

getUriBytes()

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchLinkPromotion.Builder newBuilderForType()
Returns
Type Description
SearchLinkPromotion.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchLinkPromotion.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchLinkPromotion.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchLinkPromotion.Builder toBuilder()
Returns
Type Description
SearchLinkPromotion.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException