Class UserStore.Builder (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class UserStore.Builder extends GeneratedMessage.Builder<UserStore.Builder> implements UserStoreOrBuilder

Configures metadata that is used for End User entities.

Protobuf type google.cloud.discoveryengine.v1beta.UserStore

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > UserStore.Builder

Implements

UserStoreOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public UserStore build()

Returns
Type	Description
UserStore

buildPartial()

public UserStore buildPartial()

Returns
Type	Description
UserStore

clear()

public UserStore.Builder clear()

Returns
Type	Description
UserStore.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearDefaultLicenseConfig()

public UserStore.Builder clearDefaultLicenseConfig()

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.

string default_license_config = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
UserStore.Builder	This builder for chaining.

clearDisplayName()

public UserStore.Builder clearDisplayName()

The display name of the User Store.

string display_name = 2;

Returns
Type	Description
UserStore.Builder	This builder for chaining.

clearEnableExpiredLicenseAutoUpdate()

public UserStore.Builder clearEnableExpiredLicenseAutoUpdate()

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.

bool enable_expired_license_auto_update = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserStore.Builder	This builder for chaining.

clearEnableLicenseAutoRegister()

public UserStore.Builder clearEnableLicenseAutoRegister()

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.

bool enable_license_auto_register = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserStore.Builder	This builder for chaining.

clearName()

public UserStore.Builder clearName()

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.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
UserStore.Builder	This builder for chaining.

getDefaultInstanceForType()

public UserStore getDefaultInstanceForType()

Returns
Type	Description
UserStore

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.

string default_license_config = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The defaultLicenseConfig.

getDefaultLicenseConfigBytes()

public ByteString getDefaultLicenseConfigBytes()

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.

string default_license_config = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for defaultLicenseConfig.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

The display name of the User Store.

string display_name = 2;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the User Store.

string display_name = 2;

Returns
Type	Description
ByteString	The bytes for displayName.

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.

bool enable_expired_license_auto_update = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableExpiredLicenseAutoUpdate.

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.

bool enable_license_auto_register = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableLicenseAutoRegister.

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.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

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.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(UserStore other)

public UserStore.Builder mergeFrom(UserStore other)

Parameter
Name	Description
other	UserStore

Returns
Type	Description
UserStore.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UserStore.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserStore.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public UserStore.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
UserStore.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setDefaultLicenseConfig(String value)

public UserStore.Builder setDefaultLicenseConfig(String value)

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.

string default_license_config = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	String The defaultLicenseConfig to set.

Returns
Type	Description
UserStore.Builder	This builder for chaining.

setDefaultLicenseConfigBytes(ByteString value)

public UserStore.Builder setDefaultLicenseConfigBytes(ByteString value)

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.

string default_license_config = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	ByteString The bytes for defaultLicenseConfig to set.

Returns
Type	Description
UserStore.Builder	This builder for chaining.

setDisplayName(String value)

public UserStore.Builder setDisplayName(String value)

The display name of the User Store.

string display_name = 2;

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
UserStore.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public UserStore.Builder setDisplayNameBytes(ByteString value)

The display name of the User Store.

string display_name = 2;

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
UserStore.Builder	This builder for chaining.

setEnableExpiredLicenseAutoUpdate(boolean value)

public UserStore.Builder setEnableExpiredLicenseAutoUpdate(boolean value)

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.

bool enable_expired_license_auto_update = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The enableExpiredLicenseAutoUpdate to set.

Returns
Type	Description
UserStore.Builder	This builder for chaining.

setEnableLicenseAutoRegister(boolean value)

public UserStore.Builder setEnableLicenseAutoRegister(boolean value)

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.

bool enable_license_auto_register = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The enableLicenseAutoRegister to set.

Returns
Type	Description
UserStore.Builder	This builder for chaining.

setName(String value)

public UserStore.Builder setName(String value)

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.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
UserStore.Builder	This builder for chaining.

setNameBytes(ByteString value)

public UserStore.Builder setNameBytes(ByteString value)

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.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
UserStore.Builder	This builder for chaining.