Class PropertyDefinition.Builder (0.45.0)

public static final class PropertyDefinition.Builder extends GeneratedMessageV3.Builder<PropertyDefinition.Builder> implements PropertyDefinitionOrBuilder

Defines the metadata for a schema property.

Protobuf type google.cloud.contentwarehouse.v1.PropertyDefinition

Static Methods

getDescriptor()

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

Methods

addAllSchemaSources(Iterable<? extends PropertyDefinition.SchemaSource> values)

public PropertyDefinition.Builder addAllSchemaSources(Iterable<? extends PropertyDefinition.SchemaSource> values)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameter
Name Description
values Iterable<? extends com.google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource>
Returns
Type Description
PropertyDefinition.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addSchemaSources(PropertyDefinition.SchemaSource value)

public PropertyDefinition.Builder addSchemaSources(PropertyDefinition.SchemaSource value)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameter
Name Description
value PropertyDefinition.SchemaSource
Returns
Type Description
PropertyDefinition.Builder

addSchemaSources(PropertyDefinition.SchemaSource.Builder builderForValue)

public PropertyDefinition.Builder addSchemaSources(PropertyDefinition.SchemaSource.Builder builderForValue)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameter
Name Description
builderForValue PropertyDefinition.SchemaSource.Builder
Returns
Type Description
PropertyDefinition.Builder

addSchemaSources(int index, PropertyDefinition.SchemaSource value)

public PropertyDefinition.Builder addSchemaSources(int index, PropertyDefinition.SchemaSource value)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameters
Name Description
index int
value PropertyDefinition.SchemaSource
Returns
Type Description
PropertyDefinition.Builder

addSchemaSources(int index, PropertyDefinition.SchemaSource.Builder builderForValue)

public PropertyDefinition.Builder addSchemaSources(int index, PropertyDefinition.SchemaSource.Builder builderForValue)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameters
Name Description
index int
builderForValue PropertyDefinition.SchemaSource.Builder
Returns
Type Description
PropertyDefinition.Builder

addSchemaSourcesBuilder()

public PropertyDefinition.SchemaSource.Builder addSchemaSourcesBuilder()

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Returns
Type Description
PropertyDefinition.SchemaSource.Builder

addSchemaSourcesBuilder(int index)

public PropertyDefinition.SchemaSource.Builder addSchemaSourcesBuilder(int index)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameter
Name Description
index int
Returns
Type Description
PropertyDefinition.SchemaSource.Builder

build()

public PropertyDefinition build()
Returns
Type Description
PropertyDefinition

buildPartial()

public PropertyDefinition buildPartial()
Returns
Type Description
PropertyDefinition

clear()

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

clearDateTimeTypeOptions()

public PropertyDefinition.Builder clearDateTimeTypeOptions()

Date time property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;

Returns
Type Description
PropertyDefinition.Builder

clearDisplayName()

public PropertyDefinition.Builder clearDisplayName()

The display-name for the property, used for front-end.

string display_name = 12;

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

clearEnumTypeOptions()

public PropertyDefinition.Builder clearEnumTypeOptions()

Enum/categorical property.

.google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;

Returns
Type Description
PropertyDefinition.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearFloatTypeOptions()

public PropertyDefinition.Builder clearFloatTypeOptions()

Float property.

.google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;

Returns
Type Description
PropertyDefinition.Builder

clearIntegerTypeOptions()

public PropertyDefinition.Builder clearIntegerTypeOptions()

Integer property.

.google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;

Returns
Type Description
PropertyDefinition.Builder

clearIsFilterable()

public PropertyDefinition.Builder clearIsFilterable()

Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.

bool is_filterable = 3;

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

clearIsMetadata()

public PropertyDefinition.Builder clearIsMetadata()

Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.

bool is_metadata = 5;

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

clearIsRepeatable()

public PropertyDefinition.Builder clearIsRepeatable()

Whether the property can have multiple values.

bool is_repeatable = 2;

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

clearIsRequired()

public PropertyDefinition.Builder clearIsRequired()

Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.

bool is_required = 14;

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

clearIsSearchable()

public PropertyDefinition.Builder clearIsSearchable()

Indicates that the property should be included in a global search.

bool is_searchable = 4;

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

clearMapTypeOptions()

public PropertyDefinition.Builder clearMapTypeOptions()

Map property.

.google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;

Returns
Type Description
PropertyDefinition.Builder

clearName()

public PropertyDefinition.Builder clearName()

Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .

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

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPropertyTypeOptions()

public PropertyDefinition.Builder clearPropertyTypeOptions()

Nested structured data property.

.google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;

Returns
Type Description
PropertyDefinition.Builder

clearRetrievalImportance()

public PropertyDefinition.Builder clearRetrievalImportance()

The retrieval importance of the property during search.

.google.cloud.contentwarehouse.v1.PropertyDefinition.RetrievalImportance retrieval_importance = 18;

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

clearSchemaSources()

public PropertyDefinition.Builder clearSchemaSources()

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Returns
Type Description
PropertyDefinition.Builder

clearTextTypeOptions()

public PropertyDefinition.Builder clearTextTypeOptions()

Text/string property.

.google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;

Returns
Type Description
PropertyDefinition.Builder

clearTimestampTypeOptions()

public PropertyDefinition.Builder clearTimestampTypeOptions()

Timestamp property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;

Returns
Type Description
PropertyDefinition.Builder

clearValueTypeOptions()

public PropertyDefinition.Builder clearValueTypeOptions()
Returns
Type Description
PropertyDefinition.Builder

clone()

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

getDateTimeTypeOptions()

public DateTimeTypeOptions getDateTimeTypeOptions()

Date time property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;

Returns
Type Description
DateTimeTypeOptions

The dateTimeTypeOptions.

getDateTimeTypeOptionsBuilder()

public DateTimeTypeOptions.Builder getDateTimeTypeOptionsBuilder()

Date time property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;

Returns
Type Description
DateTimeTypeOptions.Builder

getDateTimeTypeOptionsOrBuilder()

public DateTimeTypeOptionsOrBuilder getDateTimeTypeOptionsOrBuilder()

Date time property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;

Returns
Type Description
DateTimeTypeOptionsOrBuilder

getDefaultInstanceForType()

public PropertyDefinition getDefaultInstanceForType()
Returns
Type Description
PropertyDefinition

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

The display-name for the property, used for front-end.

string display_name = 12;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display-name for the property, used for front-end.

string display_name = 12;

Returns
Type Description
ByteString

The bytes for displayName.

getEnumTypeOptions()

public EnumTypeOptions getEnumTypeOptions()

Enum/categorical property.

.google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;

Returns
Type Description
EnumTypeOptions

The enumTypeOptions.

getEnumTypeOptionsBuilder()

public EnumTypeOptions.Builder getEnumTypeOptionsBuilder()

Enum/categorical property.

.google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;

Returns
Type Description
EnumTypeOptions.Builder

getEnumTypeOptionsOrBuilder()

public EnumTypeOptionsOrBuilder getEnumTypeOptionsOrBuilder()

Enum/categorical property.

.google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;

Returns
Type Description
EnumTypeOptionsOrBuilder

getFloatTypeOptions()

public FloatTypeOptions getFloatTypeOptions()

Float property.

.google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;

Returns
Type Description
FloatTypeOptions

The floatTypeOptions.

getFloatTypeOptionsBuilder()

public FloatTypeOptions.Builder getFloatTypeOptionsBuilder()

Float property.

.google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;

Returns
Type Description
FloatTypeOptions.Builder

getFloatTypeOptionsOrBuilder()

public FloatTypeOptionsOrBuilder getFloatTypeOptionsOrBuilder()

Float property.

.google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;

Returns
Type Description
FloatTypeOptionsOrBuilder

getIntegerTypeOptions()

public IntegerTypeOptions getIntegerTypeOptions()

Integer property.

.google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;

Returns
Type Description
IntegerTypeOptions

The integerTypeOptions.

getIntegerTypeOptionsBuilder()

public IntegerTypeOptions.Builder getIntegerTypeOptionsBuilder()

Integer property.

.google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;

Returns
Type Description
IntegerTypeOptions.Builder

getIntegerTypeOptionsOrBuilder()

public IntegerTypeOptionsOrBuilder getIntegerTypeOptionsOrBuilder()

Integer property.

.google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;

Returns
Type Description
IntegerTypeOptionsOrBuilder

getIsFilterable()

public boolean getIsFilterable()

Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.

bool is_filterable = 3;

Returns
Type Description
boolean

The isFilterable.

getIsMetadata()

public boolean getIsMetadata()

Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.

bool is_metadata = 5;

Returns
Type Description
boolean

The isMetadata.

getIsRepeatable()

public boolean getIsRepeatable()

Whether the property can have multiple values.

bool is_repeatable = 2;

Returns
Type Description
boolean

The isRepeatable.

getIsRequired()

public boolean getIsRequired()

Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.

bool is_required = 14;

Returns
Type Description
boolean

The isRequired.

getIsSearchable()

public boolean getIsSearchable()

Indicates that the property should be included in a global search.

bool is_searchable = 4;

Returns
Type Description
boolean

The isSearchable.

getMapTypeOptions()

public MapTypeOptions getMapTypeOptions()

Map property.

.google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;

Returns
Type Description
MapTypeOptions

The mapTypeOptions.

getMapTypeOptionsBuilder()

public MapTypeOptions.Builder getMapTypeOptionsBuilder()

Map property.

.google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;

Returns
Type Description
MapTypeOptions.Builder

getMapTypeOptionsOrBuilder()

public MapTypeOptionsOrBuilder getMapTypeOptionsOrBuilder()

Map property.

.google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;

Returns
Type Description
MapTypeOptionsOrBuilder

getName()

public String getName()

Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .

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

Returns
Type Description
ByteString

The bytes for name.

getPropertyTypeOptions()

public PropertyTypeOptions getPropertyTypeOptions()

Nested structured data property.

.google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;

Returns
Type Description
PropertyTypeOptions

The propertyTypeOptions.

getPropertyTypeOptionsBuilder()

public PropertyTypeOptions.Builder getPropertyTypeOptionsBuilder()

Nested structured data property.

.google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;

Returns
Type Description
PropertyTypeOptions.Builder

getPropertyTypeOptionsOrBuilder()

public PropertyTypeOptionsOrBuilder getPropertyTypeOptionsOrBuilder()

Nested structured data property.

.google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;

Returns
Type Description
PropertyTypeOptionsOrBuilder

getRetrievalImportance()

public PropertyDefinition.RetrievalImportance getRetrievalImportance()

The retrieval importance of the property during search.

.google.cloud.contentwarehouse.v1.PropertyDefinition.RetrievalImportance retrieval_importance = 18;

Returns
Type Description
PropertyDefinition.RetrievalImportance

The retrievalImportance.

getRetrievalImportanceValue()

public int getRetrievalImportanceValue()

The retrieval importance of the property during search.

.google.cloud.contentwarehouse.v1.PropertyDefinition.RetrievalImportance retrieval_importance = 18;

Returns
Type Description
int

The enum numeric value on the wire for retrievalImportance.

getSchemaSources(int index)

public PropertyDefinition.SchemaSource getSchemaSources(int index)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameter
Name Description
index int
Returns
Type Description
PropertyDefinition.SchemaSource

getSchemaSourcesBuilder(int index)

public PropertyDefinition.SchemaSource.Builder getSchemaSourcesBuilder(int index)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameter
Name Description
index int
Returns
Type Description
PropertyDefinition.SchemaSource.Builder

getSchemaSourcesBuilderList()

public List<PropertyDefinition.SchemaSource.Builder> getSchemaSourcesBuilderList()

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Returns
Type Description
List<Builder>

getSchemaSourcesCount()

public int getSchemaSourcesCount()

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Returns
Type Description
int

getSchemaSourcesList()

public List<PropertyDefinition.SchemaSource> getSchemaSourcesList()

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Returns
Type Description
List<SchemaSource>

getSchemaSourcesOrBuilder(int index)

public PropertyDefinition.SchemaSourceOrBuilder getSchemaSourcesOrBuilder(int index)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameter
Name Description
index int
Returns
Type Description
PropertyDefinition.SchemaSourceOrBuilder

getSchemaSourcesOrBuilderList()

public List<? extends PropertyDefinition.SchemaSourceOrBuilder> getSchemaSourcesOrBuilderList()

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Returns
Type Description
List<? extends com.google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSourceOrBuilder>

getTextTypeOptions()

public TextTypeOptions getTextTypeOptions()

Text/string property.

.google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;

Returns
Type Description
TextTypeOptions

The textTypeOptions.

getTextTypeOptionsBuilder()

public TextTypeOptions.Builder getTextTypeOptionsBuilder()

Text/string property.

.google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;

Returns
Type Description
TextTypeOptions.Builder

getTextTypeOptionsOrBuilder()

public TextTypeOptionsOrBuilder getTextTypeOptionsOrBuilder()

Text/string property.

.google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;

Returns
Type Description
TextTypeOptionsOrBuilder

getTimestampTypeOptions()

public TimestampTypeOptions getTimestampTypeOptions()

Timestamp property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;

Returns
Type Description
TimestampTypeOptions

The timestampTypeOptions.

getTimestampTypeOptionsBuilder()

public TimestampTypeOptions.Builder getTimestampTypeOptionsBuilder()

Timestamp property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;

Returns
Type Description
TimestampTypeOptions.Builder

getTimestampTypeOptionsOrBuilder()

public TimestampTypeOptionsOrBuilder getTimestampTypeOptionsOrBuilder()

Timestamp property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;

Returns
Type Description
TimestampTypeOptionsOrBuilder

getValueTypeOptionsCase()

public PropertyDefinition.ValueTypeOptionsCase getValueTypeOptionsCase()
Returns
Type Description
PropertyDefinition.ValueTypeOptionsCase

hasDateTimeTypeOptions()

public boolean hasDateTimeTypeOptions()

Date time property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;

Returns
Type Description
boolean

Whether the dateTimeTypeOptions field is set.

hasEnumTypeOptions()

public boolean hasEnumTypeOptions()

Enum/categorical property.

.google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;

Returns
Type Description
boolean

Whether the enumTypeOptions field is set.

hasFloatTypeOptions()

public boolean hasFloatTypeOptions()

Float property.

.google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;

Returns
Type Description
boolean

Whether the floatTypeOptions field is set.

hasIntegerTypeOptions()

public boolean hasIntegerTypeOptions()

Integer property.

.google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;

Returns
Type Description
boolean

Whether the integerTypeOptions field is set.

hasMapTypeOptions()

public boolean hasMapTypeOptions()

Map property.

.google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;

Returns
Type Description
boolean

Whether the mapTypeOptions field is set.

hasPropertyTypeOptions()

public boolean hasPropertyTypeOptions()

Nested structured data property.

.google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;

Returns
Type Description
boolean

Whether the propertyTypeOptions field is set.

hasTextTypeOptions()

public boolean hasTextTypeOptions()

Text/string property.

.google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;

Returns
Type Description
boolean

Whether the textTypeOptions field is set.

hasTimestampTypeOptions()

public boolean hasTimestampTypeOptions()

Timestamp property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;

Returns
Type Description
boolean

Whether the timestampTypeOptions field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDateTimeTypeOptions(DateTimeTypeOptions value)

public PropertyDefinition.Builder mergeDateTimeTypeOptions(DateTimeTypeOptions value)

Date time property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;

Parameter
Name Description
value DateTimeTypeOptions
Returns
Type Description
PropertyDefinition.Builder

mergeEnumTypeOptions(EnumTypeOptions value)

public PropertyDefinition.Builder mergeEnumTypeOptions(EnumTypeOptions value)

Enum/categorical property.

.google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;

Parameter
Name Description
value EnumTypeOptions
Returns
Type Description
PropertyDefinition.Builder

mergeFloatTypeOptions(FloatTypeOptions value)

public PropertyDefinition.Builder mergeFloatTypeOptions(FloatTypeOptions value)

Float property.

.google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;

Parameter
Name Description
value FloatTypeOptions
Returns
Type Description
PropertyDefinition.Builder

mergeFrom(PropertyDefinition other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeIntegerTypeOptions(IntegerTypeOptions value)

public PropertyDefinition.Builder mergeIntegerTypeOptions(IntegerTypeOptions value)

Integer property.

.google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;

Parameter
Name Description
value IntegerTypeOptions
Returns
Type Description
PropertyDefinition.Builder

mergeMapTypeOptions(MapTypeOptions value)

public PropertyDefinition.Builder mergeMapTypeOptions(MapTypeOptions value)

Map property.

.google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;

Parameter
Name Description
value MapTypeOptions
Returns
Type Description
PropertyDefinition.Builder

mergePropertyTypeOptions(PropertyTypeOptions value)

public PropertyDefinition.Builder mergePropertyTypeOptions(PropertyTypeOptions value)

Nested structured data property.

.google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;

Parameter
Name Description
value PropertyTypeOptions
Returns
Type Description
PropertyDefinition.Builder

mergeTextTypeOptions(TextTypeOptions value)

public PropertyDefinition.Builder mergeTextTypeOptions(TextTypeOptions value)

Text/string property.

.google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;

Parameter
Name Description
value TextTypeOptions
Returns
Type Description
PropertyDefinition.Builder

mergeTimestampTypeOptions(TimestampTypeOptions value)

public PropertyDefinition.Builder mergeTimestampTypeOptions(TimestampTypeOptions value)

Timestamp property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;

Parameter
Name Description
value TimestampTypeOptions
Returns
Type Description
PropertyDefinition.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeSchemaSources(int index)

public PropertyDefinition.Builder removeSchemaSources(int index)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameter
Name Description
index int
Returns
Type Description
PropertyDefinition.Builder

setDateTimeTypeOptions(DateTimeTypeOptions value)

public PropertyDefinition.Builder setDateTimeTypeOptions(DateTimeTypeOptions value)

Date time property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;

Parameter
Name Description
value DateTimeTypeOptions
Returns
Type Description
PropertyDefinition.Builder

setDateTimeTypeOptions(DateTimeTypeOptions.Builder builderForValue)

public PropertyDefinition.Builder setDateTimeTypeOptions(DateTimeTypeOptions.Builder builderForValue)

Date time property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;

Parameter
Name Description
builderForValue DateTimeTypeOptions.Builder
Returns
Type Description
PropertyDefinition.Builder

setDisplayName(String value)

public PropertyDefinition.Builder setDisplayName(String value)

The display-name for the property, used for front-end.

string display_name = 12;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public PropertyDefinition.Builder setDisplayNameBytes(ByteString value)

The display-name for the property, used for front-end.

string display_name = 12;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setEnumTypeOptions(EnumTypeOptions value)

public PropertyDefinition.Builder setEnumTypeOptions(EnumTypeOptions value)

Enum/categorical property.

.google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;

Parameter
Name Description
value EnumTypeOptions
Returns
Type Description
PropertyDefinition.Builder

setEnumTypeOptions(EnumTypeOptions.Builder builderForValue)

public PropertyDefinition.Builder setEnumTypeOptions(EnumTypeOptions.Builder builderForValue)

Enum/categorical property.

.google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;

Parameter
Name Description
builderForValue EnumTypeOptions.Builder
Returns
Type Description
PropertyDefinition.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setFloatTypeOptions(FloatTypeOptions value)

public PropertyDefinition.Builder setFloatTypeOptions(FloatTypeOptions value)

Float property.

.google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;

Parameter
Name Description
value FloatTypeOptions
Returns
Type Description
PropertyDefinition.Builder

setFloatTypeOptions(FloatTypeOptions.Builder builderForValue)

public PropertyDefinition.Builder setFloatTypeOptions(FloatTypeOptions.Builder builderForValue)

Float property.

.google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;

Parameter
Name Description
builderForValue FloatTypeOptions.Builder
Returns
Type Description
PropertyDefinition.Builder

setIntegerTypeOptions(IntegerTypeOptions value)

public PropertyDefinition.Builder setIntegerTypeOptions(IntegerTypeOptions value)

Integer property.

.google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;

Parameter
Name Description
value IntegerTypeOptions
Returns
Type Description
PropertyDefinition.Builder

setIntegerTypeOptions(IntegerTypeOptions.Builder builderForValue)

public PropertyDefinition.Builder setIntegerTypeOptions(IntegerTypeOptions.Builder builderForValue)

Integer property.

.google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;

Parameter
Name Description
builderForValue IntegerTypeOptions.Builder
Returns
Type Description
PropertyDefinition.Builder

setIsFilterable(boolean value)

public PropertyDefinition.Builder setIsFilterable(boolean value)

Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.

bool is_filterable = 3;

Parameter
Name Description
value boolean

The isFilterable to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setIsMetadata(boolean value)

public PropertyDefinition.Builder setIsMetadata(boolean value)

Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.

bool is_metadata = 5;

Parameter
Name Description
value boolean

The isMetadata to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setIsRepeatable(boolean value)

public PropertyDefinition.Builder setIsRepeatable(boolean value)

Whether the property can have multiple values.

bool is_repeatable = 2;

Parameter
Name Description
value boolean

The isRepeatable to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setIsRequired(boolean value)

public PropertyDefinition.Builder setIsRequired(boolean value)

Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.

bool is_required = 14;

Parameter
Name Description
value boolean

The isRequired to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setIsSearchable(boolean value)

public PropertyDefinition.Builder setIsSearchable(boolean value)

Indicates that the property should be included in a global search.

bool is_searchable = 4;

Parameter
Name Description
value boolean

The isSearchable to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setMapTypeOptions(MapTypeOptions value)

public PropertyDefinition.Builder setMapTypeOptions(MapTypeOptions value)

Map property.

.google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;

Parameter
Name Description
value MapTypeOptions
Returns
Type Description
PropertyDefinition.Builder

setMapTypeOptions(MapTypeOptions.Builder builderForValue)

public PropertyDefinition.Builder setMapTypeOptions(MapTypeOptions.Builder builderForValue)

Map property.

.google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;

Parameter
Name Description
builderForValue MapTypeOptions.Builder
Returns
Type Description
PropertyDefinition.Builder

setName(String value)

public PropertyDefinition.Builder setName(String value)

Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setNameBytes(ByteString value)

public PropertyDefinition.Builder setNameBytes(ByteString value)

Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setPropertyTypeOptions(PropertyTypeOptions value)

public PropertyDefinition.Builder setPropertyTypeOptions(PropertyTypeOptions value)

Nested structured data property.

.google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;

Parameter
Name Description
value PropertyTypeOptions
Returns
Type Description
PropertyDefinition.Builder

setPropertyTypeOptions(PropertyTypeOptions.Builder builderForValue)

public PropertyDefinition.Builder setPropertyTypeOptions(PropertyTypeOptions.Builder builderForValue)

Nested structured data property.

.google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;

Parameter
Name Description
builderForValue PropertyTypeOptions.Builder
Returns
Type Description
PropertyDefinition.Builder

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

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

setRetrievalImportance(PropertyDefinition.RetrievalImportance value)

public PropertyDefinition.Builder setRetrievalImportance(PropertyDefinition.RetrievalImportance value)

The retrieval importance of the property during search.

.google.cloud.contentwarehouse.v1.PropertyDefinition.RetrievalImportance retrieval_importance = 18;

Parameter
Name Description
value PropertyDefinition.RetrievalImportance

The retrievalImportance to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setRetrievalImportanceValue(int value)

public PropertyDefinition.Builder setRetrievalImportanceValue(int value)

The retrieval importance of the property during search.

.google.cloud.contentwarehouse.v1.PropertyDefinition.RetrievalImportance retrieval_importance = 18;

Parameter
Name Description
value int

The enum numeric value on the wire for retrievalImportance to set.

Returns
Type Description
PropertyDefinition.Builder

This builder for chaining.

setSchemaSources(int index, PropertyDefinition.SchemaSource value)

public PropertyDefinition.Builder setSchemaSources(int index, PropertyDefinition.SchemaSource value)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameters
Name Description
index int
value PropertyDefinition.SchemaSource
Returns
Type Description
PropertyDefinition.Builder

setSchemaSources(int index, PropertyDefinition.SchemaSource.Builder builderForValue)

public PropertyDefinition.Builder setSchemaSources(int index, PropertyDefinition.SchemaSource.Builder builderForValue)

The mapping information between this property to another schema source.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

Parameters
Name Description
index int
builderForValue PropertyDefinition.SchemaSource.Builder
Returns
Type Description
PropertyDefinition.Builder

setTextTypeOptions(TextTypeOptions value)

public PropertyDefinition.Builder setTextTypeOptions(TextTypeOptions value)

Text/string property.

.google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;

Parameter
Name Description
value TextTypeOptions
Returns
Type Description
PropertyDefinition.Builder

setTextTypeOptions(TextTypeOptions.Builder builderForValue)

public PropertyDefinition.Builder setTextTypeOptions(TextTypeOptions.Builder builderForValue)

Text/string property.

.google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;

Parameter
Name Description
builderForValue TextTypeOptions.Builder
Returns
Type Description
PropertyDefinition.Builder

setTimestampTypeOptions(TimestampTypeOptions value)

public PropertyDefinition.Builder setTimestampTypeOptions(TimestampTypeOptions value)

Timestamp property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;

Parameter
Name Description
value TimestampTypeOptions
Returns
Type Description
PropertyDefinition.Builder

setTimestampTypeOptions(TimestampTypeOptions.Builder builderForValue)

public PropertyDefinition.Builder setTimestampTypeOptions(TimestampTypeOptions.Builder builderForValue)

Timestamp property. It is not supported by CMEK compliant deployment.

.google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;

Parameter
Name Description
builderForValue TimestampTypeOptions.Builder
Returns
Type Description
PropertyDefinition.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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