Interface PropertyDefinitionOrBuilder (0.24.0)

Version 0.24.0

• 0.51.0 (latest)
• 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.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface PropertyDefinitionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDateTimeTypeOptions()

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

getDateTimeTypeOptionsOrBuilder()

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

getDisplayName()

public abstract String getDisplayName()

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

string display_name = 12;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract 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 abstract EnumTypeOptions getEnumTypeOptions()

Enum/categorical property.

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

Returns
Type	Description
EnumTypeOptions	The enumTypeOptions.

getEnumTypeOptionsOrBuilder()

public abstract EnumTypeOptionsOrBuilder getEnumTypeOptionsOrBuilder()

Enum/categorical property.

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

Returns
Type	Description
EnumTypeOptionsOrBuilder

getFloatTypeOptions()

public abstract FloatTypeOptions getFloatTypeOptions()

Float property.

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

Returns
Type	Description
FloatTypeOptions	The floatTypeOptions.

getFloatTypeOptionsOrBuilder()

public abstract FloatTypeOptionsOrBuilder getFloatTypeOptionsOrBuilder()

Float property.

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

Returns
Type	Description
FloatTypeOptionsOrBuilder

getIntegerTypeOptions()

public abstract IntegerTypeOptions getIntegerTypeOptions()

Integer property.

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

Returns
Type	Description
IntegerTypeOptions	The integerTypeOptions.

getIntegerTypeOptionsOrBuilder()

public abstract IntegerTypeOptionsOrBuilder getIntegerTypeOptionsOrBuilder()

Integer property.

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

Returns
Type	Description
IntegerTypeOptionsOrBuilder

getIsFilterable()

public abstract 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 abstract 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 abstract boolean getIsRepeatable()

Whether the property can have multiple values.

bool is_repeatable = 2;

Returns
Type	Description
boolean	The isRepeatable.

getIsRequired()

public abstract 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 abstract 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 abstract MapTypeOptions getMapTypeOptions()

Map property.

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

Returns
Type	Description
MapTypeOptions	The mapTypeOptions.

getMapTypeOptionsOrBuilder()

public abstract MapTypeOptionsOrBuilder getMapTypeOptionsOrBuilder()

Map property.

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

Returns
Type	Description
MapTypeOptionsOrBuilder

getName()

public abstract 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 abstract 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 abstract PropertyTypeOptions getPropertyTypeOptions()

Nested structured data property.

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

Returns
Type	Description
PropertyTypeOptions	The propertyTypeOptions.

getPropertyTypeOptionsOrBuilder()

public abstract PropertyTypeOptionsOrBuilder getPropertyTypeOptionsOrBuilder()

Nested structured data property.

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

Returns
Type	Description
PropertyTypeOptionsOrBuilder

getRetrievalImportance()

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

getSchemaSourcesCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract TextTypeOptions getTextTypeOptions()

Text/string property.

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

Returns
Type	Description
TextTypeOptions	The textTypeOptions.

getTextTypeOptionsOrBuilder()

public abstract TextTypeOptionsOrBuilder getTextTypeOptionsOrBuilder()

Text/string property.

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

Returns
Type	Description
TextTypeOptionsOrBuilder

getTimestampTypeOptions()

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

getTimestampTypeOptionsOrBuilder()

public abstract 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 abstract PropertyDefinition.ValueTypeOptionsCase getValueTypeOptionsCase()

Returns
Type	Description
PropertyDefinition.ValueTypeOptionsCase

hasDateTimeTypeOptions()

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