Class SetUriPatternDocumentDataRequest.Builder (0.49.0)

public static final class SetUriPatternDocumentDataRequest.Builder extends GeneratedMessageV3.Builder<SetUriPatternDocumentDataRequest.Builder> implements SetUriPatternDocumentDataRequestOrBuilder

Request message for SiteSearchEngineService.SetUriPatternDocumentData method.

Protobuf type google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SetUriPatternDocumentDataRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides

build()

public SetUriPatternDocumentDataRequest build()
Returns
Type Description
SetUriPatternDocumentDataRequest

buildPartial()

public SetUriPatternDocumentDataRequest buildPartial()
Returns
Type Description
SetUriPatternDocumentDataRequest

clear()

public SetUriPatternDocumentDataRequest.Builder clear()
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides

clearDocumentDataMap()

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

clearEmptyDocumentDataMap()

public SetUriPatternDocumentDataRequest.Builder clearEmptyDocumentDataMap()

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
SetUriPatternDocumentDataRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SetUriPatternDocumentDataRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SetUriPatternDocumentDataRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides

clearSchema()

public SetUriPatternDocumentDataRequest.Builder clearSchema()

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
SetUriPatternDocumentDataRequest.Builder

clearSiteSearchEngine()

public SetUriPatternDocumentDataRequest.Builder clearSiteSearchEngine()

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
SetUriPatternDocumentDataRequest.Builder

This builder for chaining.

clone()

public SetUriPatternDocumentDataRequest.Builder clone()
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides

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

getDefaultInstanceForType()

public SetUriPatternDocumentDataRequest getDefaultInstanceForType()
Returns
Type Description
SetUriPatternDocumentDataRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getMutableDocumentDataMap() (deprecated)

public Map<String,Struct> getMutableDocumentDataMap()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,Struct>

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.

getSchemaBuilder()

public Struct.Builder getSchemaBuilder()

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
Builder

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

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SetUriPatternDocumentDataRequest other)

public SetUriPatternDocumentDataRequest.Builder mergeFrom(SetUriPatternDocumentDataRequest other)
Parameter
Name Description
other SetUriPatternDocumentDataRequest
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SetUriPatternDocumentDataRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SetUriPatternDocumentDataRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides

mergeSchema(Struct value)

public SetUriPatternDocumentDataRequest.Builder mergeSchema(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SetUriPatternDocumentDataRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides

putAllDocumentDataMap(Map<String,Struct> values)

public SetUriPatternDocumentDataRequest.Builder putAllDocumentDataMap(Map<String,Struct> values)

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
values Map<String,Struct>
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder

putDocumentDataMap(String key, Struct value)

public SetUriPatternDocumentDataRequest.Builder putDocumentDataMap(String key, Struct value)

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
value Struct
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder

putDocumentDataMapBuilderIfAbsent(String key)

public Struct.Builder putDocumentDataMapBuilderIfAbsent(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
Builder

removeDocumentDataMap(String key)

public SetUriPatternDocumentDataRequest.Builder removeDocumentDataMap(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
SetUriPatternDocumentDataRequest.Builder

setEmptyDocumentDataMap(boolean value)

public SetUriPatternDocumentDataRequest.Builder setEmptyDocumentDataMap(boolean value)

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

bool empty_document_data_map = 4;

Parameter
Name Description
value boolean

The emptyDocumentDataMap to set.

Returns
Type Description
SetUriPatternDocumentDataRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SetUriPatternDocumentDataRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SetUriPatternDocumentDataRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides

setSchema(Struct value)

public SetUriPatternDocumentDataRequest.Builder setSchema(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder

setSchema(Struct.Builder builderForValue)

public SetUriPatternDocumentDataRequest.Builder setSchema(Struct.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder

setSiteSearchEngine(String value)

public SetUriPatternDocumentDataRequest.Builder setSiteSearchEngine(String value)

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

Parameter
Name Description
value String

The siteSearchEngine to set.

Returns
Type Description
SetUriPatternDocumentDataRequest.Builder

This builder for chaining.

setSiteSearchEngineBytes(ByteString value)

public SetUriPatternDocumentDataRequest.Builder setSiteSearchEngineBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for siteSearchEngine to set.

Returns
Type Description
SetUriPatternDocumentDataRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SetUriPatternDocumentDataRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SetUriPatternDocumentDataRequest.Builder
Overrides