com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1UserStore

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1UserStore

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1UserStore
extends com.google.api.client.json.GenericJson

Configures metadata that is used for End User entities.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1UserStore()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1UserStore	clone()
String	getDefaultLicenseConfig() Optional.
String	getDisplayName() The display name of the User Store.
Boolean	getEnableExpiredLicenseAutoUpdate() Optional.
Boolean	getEnableLicenseAutoRegister() Optional.
String	getName() Immutable.
GoogleCloudDiscoveryengineV1UserStore	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1UserStore	setDefaultLicenseConfig(String defaultLicenseConfig) Optional.
GoogleCloudDiscoveryengineV1UserStore	setDisplayName(String displayName) The display name of the User Store.
GoogleCloudDiscoveryengineV1UserStore	setEnableExpiredLicenseAutoUpdate(Boolean enableExpiredLicenseAutoUpdate) Optional.
GoogleCloudDiscoveryengineV1UserStore	setEnableLicenseAutoRegister(Boolean enableLicenseAutoRegister) Optional.
GoogleCloudDiscoveryengineV1UserStore	setName(String name) Immutable.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1UserStore

public GoogleCloudDiscoveryengineV1UserStore()

Method Detail

getDefaultLicenseConfig

public String getDefaultLicenseConfig()

Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.

Returns:

value or null for none

setDefaultLicenseConfig

public GoogleCloudDiscoveryengineV1UserStore setDefaultLicenseConfig(String defaultLicenseConfig)

Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.

Parameters:

defaultLicenseConfig - defaultLicenseConfig or null for none

getDisplayName

public String getDisplayName()

The display name of the User Store.

Returns:

value or null for none

setDisplayName

public GoogleCloudDiscoveryengineV1UserStore setDisplayName(String displayName)

The display name of the User Store.

Parameters:

displayName - displayName or null for none

getEnableExpiredLicenseAutoUpdate

public Boolean getEnableExpiredLicenseAutoUpdate()

Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.

Returns:

value or null for none

setEnableExpiredLicenseAutoUpdate

public GoogleCloudDiscoveryengineV1UserStore setEnableExpiredLicenseAutoUpdate(Boolean enableExpiredLicenseAutoUpdate)

Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.

Parameters:

enableExpiredLicenseAutoUpdate - enableExpiredLicenseAutoUpdate or null for none

getEnableLicenseAutoRegister

public Boolean getEnableLicenseAutoRegister()

Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.

Returns:

value or null for none

setEnableLicenseAutoRegister

public GoogleCloudDiscoveryengineV1UserStore setEnableLicenseAutoRegister(Boolean enableLicenseAutoRegister)

Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.

Parameters:

enableLicenseAutoRegister - enableLicenseAutoRegister or null for none

getName

public String getName()

Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Returns:

value or null for none

setName

public GoogleCloudDiscoveryengineV1UserStore setName(String name)

Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Parameters:

name - name or null for none

set

public GoogleCloudDiscoveryengineV1UserStore set(String fieldName,
                                                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1UserStore clone()

Overrides:

clone in class com.google.api.client.json.GenericJson