Interface SetUriPatternDocumentDataRequestOrBuilder (0.69.0) 

public interface SetUriPatternDocumentDataRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsDocumentDataMap(String key)

public abstract 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

getDocumentDataMap() (deprecated)

public abstract Map<String,Struct> getDocumentDataMap()

Use #getDocumentDataMapMap() instead.

Returns
Type Description
Map<String,Struct>

getDocumentDataMapCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getSchema()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.