com.google.cloud.discoveryengine.v1

Class SearchLinkPromotion

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.SearchLinkPromotion

All Implemented Interfaces:

SearchLinkPromotionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class SearchLinkPromotion
extends com.google.protobuf.GeneratedMessage
implements SearchLinkPromotionOrBuilder

 Promotion proto includes uri and other helping information to display the
 promotion.
 

Protobuf type google.cloud.discoveryengine.v1.SearchLinkPromotion

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchLinkPromotion.Builder Promotion proto includes uri and other helping information to display the promotion.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DESCRIPTION_FIELD_NUMBER
static int	DOCUMENT_FIELD_NUMBER
static int	ENABLED_FIELD_NUMBER
static int	IMAGE_URI_FIELD_NUMBER
static int	TITLE_FIELD_NUMBER
static int	URI_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static SearchLinkPromotion	getDefaultInstance()
SearchLinkPromotion	getDefaultInstanceForType()
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDocument() Optional.
com.google.protobuf.ByteString	getDocumentBytes() Optional.
boolean	getEnabled() Optional.
String	getImageUri() Optional.
com.google.protobuf.ByteString	getImageUriBytes() Optional.
com.google.protobuf.Parser<SearchLinkPromotion>	getParserForType()
int	getSerializedSize()
String	getTitle() Required.
com.google.protobuf.ByteString	getTitleBytes() Required.
String	getUri() Optional.
com.google.protobuf.ByteString	getUriBytes() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchLinkPromotion.Builder	newBuilder()
static SearchLinkPromotion.Builder	newBuilder(SearchLinkPromotion prototype)
SearchLinkPromotion.Builder	newBuilderForType()
protected SearchLinkPromotion.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static SearchLinkPromotion	parseDelimitedFrom(InputStream input)
static SearchLinkPromotion	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchLinkPromotion	parseFrom(byte[] data)
static SearchLinkPromotion	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchLinkPromotion	parseFrom(ByteBuffer data)
static SearchLinkPromotion	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchLinkPromotion	parseFrom(com.google.protobuf.ByteString data)
static SearchLinkPromotion	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchLinkPromotion	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchLinkPromotion	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchLinkPromotion	parseFrom(InputStream input)
static SearchLinkPromotion	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchLinkPromotion>	parser()
SearchLinkPromotion.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER

See Also:

Constant Field Values

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER

See Also:

Constant Field Values

IMAGE_URI_FIELD_NUMBER

public static final int IMAGE_URI_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

getTitle

public String getTitle()

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

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

Specified by:

getTitle in interface SearchLinkPromotionOrBuilder

Returns:

The title.

getTitleBytes

public com.google.protobuf.ByteString getTitleBytes()

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

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

Specified by:

getTitleBytes in interface SearchLinkPromotionOrBuilder

Returns:

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];

Specified by:

getUri in interface SearchLinkPromotionOrBuilder

Returns:

The uri.

getUriBytes

public 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];

Specified by:

getUriBytes in interface SearchLinkPromotionOrBuilder

Returns:

The bytes for uri.

getDocument

public 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) = { ... }

Specified by:

getDocument in interface SearchLinkPromotionOrBuilder

Returns:

The document.

getDocumentBytes

public 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) = { ... }

Specified by:

getDocumentBytes in interface SearchLinkPromotionOrBuilder

Returns:

The bytes for document.

getImageUri

public String getImageUri()

 Optional. The promotion thumbnail image url.
 

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

Specified by:

getImageUri in interface SearchLinkPromotionOrBuilder

Returns:

The imageUri.

getImageUriBytes

public com.google.protobuf.ByteString getImageUriBytes()

 Optional. The promotion thumbnail image url.
 

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

Specified by:

getImageUriBytes in interface SearchLinkPromotionOrBuilder

Returns:

The bytes for imageUri.

getDescription

public String getDescription()

 Optional. The Promotion description.
 Maximum length: 200 characters.
 

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDescription in interface SearchLinkPromotionOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Optional. The Promotion description.
 Maximum length: 200 characters.
 

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDescriptionBytes in interface SearchLinkPromotionOrBuilder

Returns:

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];

Specified by:

getEnabled in interface SearchLinkPromotionOrBuilder

Returns:

The enabled.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchLinkPromotion parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchLinkPromotion parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchLinkPromotion parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchLinkPromotion parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchLinkPromotion parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchLinkPromotion parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchLinkPromotion parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static SearchLinkPromotion parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchLinkPromotion parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchLinkPromotion parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static SearchLinkPromotion parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static SearchLinkPromotion parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public SearchLinkPromotion.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchLinkPromotion.Builder newBuilder()

newBuilder

public static SearchLinkPromotion.Builder newBuilder(SearchLinkPromotion prototype)

toBuilder

public SearchLinkPromotion.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchLinkPromotion.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static SearchLinkPromotion getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchLinkPromotion> parser()

getParserForType

public com.google.protobuf.Parser<SearchLinkPromotion> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public SearchLinkPromotion getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder