com.google.cloud.discoveryengine.v1alpha

Class SetUriPatternDocumentDataRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest

All Implemented Interfaces:

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

public final class SetUriPatternDocumentDataRequest
extends com.google.protobuf.GeneratedMessageV3
implements SetUriPatternDocumentDataRequestOrBuilder

 Request message for
 [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
 method.
 

Protobuf type google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SetUriPatternDocumentDataRequest.Builder Request message for [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] method.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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	DOCUMENT_DATA_MAP_FIELD_NUMBER
static int	EMPTY_DOCUMENT_DATA_MAP_FIELD_NUMBER
static int	SCHEMA_FIELD_NUMBER
static int	SITE_SEARCH_ENGINE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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	containsDocumentDataMap(String key) Document data keyed by URI pattern.
boolean	equals(Object obj)
static SetUriPatternDocumentDataRequest	getDefaultInstance()
SetUriPatternDocumentDataRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Map<String,com.google.protobuf.Struct>	getDocumentDataMap() Deprecated.
int	getDocumentDataMapCount() Document data keyed by URI pattern.
Map<String,com.google.protobuf.Struct>	getDocumentDataMapMap() Document data keyed by URI pattern.
com.google.protobuf.Struct	getDocumentDataMapOrDefault(String key, com.google.protobuf.Struct defaultValue) Document data keyed by URI pattern.
com.google.protobuf.Struct	getDocumentDataMapOrThrow(String key) Document data keyed by URI pattern.
boolean	getEmptyDocumentDataMap() If true, clears the document data map.
com.google.protobuf.Parser<SetUriPatternDocumentDataRequest>	getParserForType()
com.google.protobuf.Struct	getSchema() Optional.
com.google.protobuf.StructOrBuilder	getSchemaOrBuilder() Optional.
int	getSerializedSize()
String	getSiteSearchEngine() Required.
com.google.protobuf.ByteString	getSiteSearchEngineBytes() Required.
int	hashCode()
boolean	hasSchema() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static SetUriPatternDocumentDataRequest.Builder	newBuilder()
static SetUriPatternDocumentDataRequest.Builder	newBuilder(SetUriPatternDocumentDataRequest prototype)
SetUriPatternDocumentDataRequest.Builder	newBuilderForType()
protected SetUriPatternDocumentDataRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SetUriPatternDocumentDataRequest	parseDelimitedFrom(InputStream input)
static SetUriPatternDocumentDataRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SetUriPatternDocumentDataRequest	parseFrom(byte[] data)
static SetUriPatternDocumentDataRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SetUriPatternDocumentDataRequest	parseFrom(ByteBuffer data)
static SetUriPatternDocumentDataRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SetUriPatternDocumentDataRequest	parseFrom(com.google.protobuf.ByteString data)
static SetUriPatternDocumentDataRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SetUriPatternDocumentDataRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static SetUriPatternDocumentDataRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SetUriPatternDocumentDataRequest	parseFrom(InputStream input)
static SetUriPatternDocumentDataRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SetUriPatternDocumentDataRequest>	parser()
SetUriPatternDocumentDataRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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

SITE_SEARCH_ENGINE_FIELD_NUMBER

public static final int SITE_SEARCH_ENGINE_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_DATA_MAP_FIELD_NUMBER

public static final int DOCUMENT_DATA_MAP_FIELD_NUMBER

See Also:

Constant Field Values

EMPTY_DOCUMENT_DATA_MAP_FIELD_NUMBER

public static final int EMPTY_DOCUMENT_DATA_MAP_FIELD_NUMBER

See Also:

Constant Field Values

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSiteSearchEngine

public String getSiteSearchEngine()

 Required. Full resource name of the
 [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
 such as
 `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
 

string site_search_engine = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getSiteSearchEngine in interface SetUriPatternDocumentDataRequestOrBuilder

Returns:

The siteSearchEngine.

getSiteSearchEngineBytes

public com.google.protobuf.ByteString getSiteSearchEngineBytes()

 Required. Full resource name of the
 [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
 such as
 `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
 

string site_search_engine = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getSiteSearchEngineBytes in interface SetUriPatternDocumentDataRequestOrBuilder

Returns:

The bytes for siteSearchEngine.

getDocumentDataMapCount

public int getDocumentDataMapCount()

Description copied from interface: SetUriPatternDocumentDataRequestOrBuilder

 Document data keyed by URI pattern. Each entry must be consistent with
 the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
 "type": "object",
 "properties": {
   "Categories": {
     "type": "array",
     "items": {
       "retrievable": true,
       "type": "string"
     }
   }
 }

 document_data_map = {
   "www.url1.com/*": {
     "Categories": ["category1", "category2"]
   },
   "www.url2.com/*": {
     "Categories": ["category3"]
   }
 }
 

map<string, .google.protobuf.Struct> document_data_map = 2;

Specified by:

getDocumentDataMapCount in interface SetUriPatternDocumentDataRequestOrBuilder

containsDocumentDataMap

public boolean containsDocumentDataMap(String key)

 Document data keyed by URI pattern. Each entry must be consistent with
 the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
 "type": "object",
 "properties": {
   "Categories": {
     "type": "array",
     "items": {
       "retrievable": true,
       "type": "string"
     }
   }
 }

 document_data_map = {
   "www.url1.com/*": {
     "Categories": ["category1", "category2"]
   },
   "www.url2.com/*": {
     "Categories": ["category3"]
   }
 }
 

map<string, .google.protobuf.Struct> document_data_map = 2;

Specified by:

containsDocumentDataMap in interface SetUriPatternDocumentDataRequestOrBuilder

getDocumentDataMap

@Deprecated
public Map<String,com.google.protobuf.Struct> getDocumentDataMap()

Deprecated.

Use getDocumentDataMapMap() instead.

Specified by:

getDocumentDataMap in interface SetUriPatternDocumentDataRequestOrBuilder

getDocumentDataMapMap

public Map<String,com.google.protobuf.Struct> getDocumentDataMapMap()

 Document data keyed by URI pattern. Each entry must be consistent with
 the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
 "type": "object",
 "properties": {
   "Categories": {
     "type": "array",
     "items": {
       "retrievable": true,
       "type": "string"
     }
   }
 }

 document_data_map = {
   "www.url1.com/*": {
     "Categories": ["category1", "category2"]
   },
   "www.url2.com/*": {
     "Categories": ["category3"]
   }
 }
 

map<string, .google.protobuf.Struct> document_data_map = 2;

Specified by:

getDocumentDataMapMap in interface SetUriPatternDocumentDataRequestOrBuilder

getDocumentDataMapOrDefault

public com.google.protobuf.Struct getDocumentDataMapOrDefault(String key,
                                                              com.google.protobuf.Struct defaultValue)

 Document data keyed by URI pattern. Each entry must be consistent with
 the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
 "type": "object",
 "properties": {
   "Categories": {
     "type": "array",
     "items": {
       "retrievable": true,
       "type": "string"
     }
   }
 }

 document_data_map = {
   "www.url1.com/*": {
     "Categories": ["category1", "category2"]
   },
   "www.url2.com/*": {
     "Categories": ["category3"]
   }
 }
 

map<string, .google.protobuf.Struct> document_data_map = 2;

Specified by:

getDocumentDataMapOrDefault in interface SetUriPatternDocumentDataRequestOrBuilder

getDocumentDataMapOrThrow

public com.google.protobuf.Struct getDocumentDataMapOrThrow(String key)

 Document data keyed by URI pattern. Each entry must be consistent with
 the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
 "type": "object",
 "properties": {
   "Categories": {
     "type": "array",
     "items": {
       "retrievable": true,
       "type": "string"
     }
   }
 }

 document_data_map = {
   "www.url1.com/*": {
     "Categories": ["category1", "category2"]
   },
   "www.url2.com/*": {
     "Categories": ["category3"]
   }
 }
 

map<string, .google.protobuf.Struct> document_data_map = 2;

Specified by:

getDocumentDataMapOrThrow in interface SetUriPatternDocumentDataRequestOrBuilder

getEmptyDocumentDataMap

public boolean getEmptyDocumentDataMap()

 If true, clears the document data map. If true,
 [SetUriPatternDocumentDataRequest.document_data_map][google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.document_data_map]
 must be empty.
 

bool empty_document_data_map = 4;

Specified by:

getEmptyDocumentDataMap in interface SetUriPatternDocumentDataRequestOrBuilder

Returns:

The emptyDocumentDataMap.

hasSchema

public boolean hasSchema()

 Optional. If not provided, the current
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] is used. If provided,
 validates and updates the
 [Schema][google.cloud.discoveryengine.v1alpha.Schema]. If validation fails,
 an error is returned.
 

.google.protobuf.Struct schema = 3;

Specified by:

hasSchema in interface SetUriPatternDocumentDataRequestOrBuilder

Returns:

Whether the schema field is set.

getSchema

public com.google.protobuf.Struct getSchema()

 Optional. If not provided, the current
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] is used. If provided,
 validates and updates the
 [Schema][google.cloud.discoveryengine.v1alpha.Schema]. If validation fails,
 an error is returned.
 

.google.protobuf.Struct schema = 3;

Specified by:

getSchema in interface SetUriPatternDocumentDataRequestOrBuilder

Returns:

The schema.

getSchemaOrBuilder

public com.google.protobuf.StructOrBuilder getSchemaOrBuilder()

 Optional. If not provided, the current
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] is used. If provided,
 validates and updates the
 [Schema][google.cloud.discoveryengine.v1alpha.Schema]. If validation fails,
 an error is returned.
 

.google.protobuf.Struct schema = 3;

Specified by:

getSchemaOrBuilder in interface SetUriPatternDocumentDataRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 SetUriPatternDocumentDataRequest parseFrom(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SetUriPatternDocumentDataRequest parseFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static SetUriPatternDocumentDataRequest parseDelimitedFrom(InputStream input)
                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public SetUriPatternDocumentDataRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SetUriPatternDocumentDataRequest.Builder newBuilder()

newBuilder

public static SetUriPatternDocumentDataRequest.Builder newBuilder(SetUriPatternDocumentDataRequest prototype)

toBuilder

public SetUriPatternDocumentDataRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SetUriPatternDocumentDataRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SetUriPatternDocumentDataRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<SetUriPatternDocumentDataRequest> 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.GeneratedMessageV3

getDefaultInstanceForType

public SetUriPatternDocumentDataRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder