Class SetUriPatternDocumentDataRequest (0.48.0)

public final class SetUriPatternDocumentDataRequest extends GeneratedMessageV3 implements SetUriPatternDocumentDataRequestOrBuilder

Request message for SiteSearchEngineService.SetUriPatternDocumentData method.

Protobuf type google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SetUriPatternDocumentDataRequest

Static Fields

DOCUMENT_DATA_MAP_FIELD_NUMBER

public static final int DOCUMENT_DATA_MAP_FIELD_NUMBER
Field Value
Type Description
int

EMPTY_DOCUMENT_DATA_MAP_FIELD_NUMBER

public static final int EMPTY_DOCUMENT_DATA_MAP_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

SITE_SEARCH_ENGINE_FIELD_NUMBER

public static final int SITE_SEARCH_ENGINE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SetUriPatternDocumentDataRequest getDefaultInstance()
Returns
Type Description
SetUriPatternDocumentDataRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SetUriPatternDocumentDataRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsDocumentDataMap(String key)

public boolean containsDocumentDataMap(String key)

Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: 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;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public SetUriPatternDocumentDataRequest getDefaultInstanceForType()
Returns
Type Description
SetUriPatternDocumentDataRequest

getDocumentDataMap() (deprecated)

public Map<String,Struct> getDocumentDataMap()
Returns
Type Description
Map<String,Struct>

getDocumentDataMapCount()

public int getDocumentDataMapCount()

Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: 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;

Returns
Type Description
int

getDocumentDataMapMap()

public Map<String,Struct> getDocumentDataMapMap()

Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: 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;

Returns
Type Description
Map<String,Struct>

getDocumentDataMapOrDefault(String key, Struct defaultValue)

public Struct getDocumentDataMapOrDefault(String key, Struct defaultValue)

Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: 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;

Parameters
Name Description
key String
defaultValue Struct
Returns
Type Description
Struct

getDocumentDataMapOrThrow(String key)

public Struct getDocumentDataMapOrThrow(String key)

Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: 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;

Parameter
Name Description
key String
Returns
Type Description
Struct

getEmptyDocumentDataMap()

public boolean getEmptyDocumentDataMap()

If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.

bool empty_document_data_map = 4;

Returns
Type Description
boolean

The emptyDocumentDataMap.

getParserForType()

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

getSchema()

public Struct getSchema()

Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.

.google.protobuf.Struct schema = 3;

Returns
Type Description
Struct

The schema.

getSchemaOrBuilder()

public StructOrBuilder getSchemaOrBuilder()

Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.

.google.protobuf.Struct schema = 3;

Returns
Type Description
StructOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSiteSearchEngine()

public String getSiteSearchEngine()

Required. Full resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

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

Returns
Type Description
String

The siteSearchEngine.

getSiteSearchEngineBytes()

public ByteString getSiteSearchEngineBytes()

Required. Full resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

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

Returns
Type Description
ByteString

The bytes for siteSearchEngine.

hasSchema()

public boolean hasSchema()

Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.

.google.protobuf.Struct schema = 3;

Returns
Type Description
boolean

Whether the schema field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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