Interface PropertyDefinitionOrBuilder (0.13.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
TypeDescription
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
TypeDescription
DateTimeTypeOptionsOrBuilder

getDisplayName()

public abstract String getDisplayName()

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

string display_name = 12;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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

string display_name = 12;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEnumTypeOptions()

public abstract EnumTypeOptions getEnumTypeOptions()

Enum/categorical property.

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

Returns
TypeDescription
EnumTypeOptions

The enumTypeOptions.

getEnumTypeOptionsOrBuilder()

public abstract EnumTypeOptionsOrBuilder getEnumTypeOptionsOrBuilder()

Enum/categorical property.

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

Returns
TypeDescription
EnumTypeOptionsOrBuilder

getFloatTypeOptions()

public abstract FloatTypeOptions getFloatTypeOptions()

Float property.

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

Returns
TypeDescription
FloatTypeOptions

The floatTypeOptions.

getFloatTypeOptionsOrBuilder()

public abstract FloatTypeOptionsOrBuilder getFloatTypeOptionsOrBuilder()

Float property.

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

Returns
TypeDescription
FloatTypeOptionsOrBuilder

getIntegerTypeOptions()

public abstract IntegerTypeOptions getIntegerTypeOptions()

Integer property.

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

Returns
TypeDescription
IntegerTypeOptions

The integerTypeOptions.

getIntegerTypeOptionsOrBuilder()

public abstract IntegerTypeOptionsOrBuilder getIntegerTypeOptionsOrBuilder()

Integer property.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The isMetadata.

getIsRepeatable()

public abstract boolean getIsRepeatable()

Whether the property can have multiple values.

bool is_repeatable = 2;

Returns
TypeDescription
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
TypeDescription
boolean

The isRequired.

getIsSearchable()

public abstract boolean getIsSearchable()

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

bool is_searchable = 4;

Returns
TypeDescription
boolean

The isSearchable.

getMapTypeOptions()

public abstract MapTypeOptions getMapTypeOptions()

Map property.

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

Returns
TypeDescription
MapTypeOptions

The mapTypeOptions.

getMapTypeOptionsOrBuilder()

public abstract MapTypeOptionsOrBuilder getMapTypeOptionsOrBuilder()

Map property.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getPropertyTypeOptions()

public abstract PropertyTypeOptions getPropertyTypeOptions()

Nested structured data property.

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

Returns
TypeDescription
PropertyTypeOptions

The propertyTypeOptions.

getPropertyTypeOptionsOrBuilder()

public abstract PropertyTypeOptionsOrBuilder getPropertyTypeOptionsOrBuilder()

Nested structured data property.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TextTypeOptions

The textTypeOptions.

getTextTypeOptionsOrBuilder()

public abstract TextTypeOptionsOrBuilder getTextTypeOptionsOrBuilder()

Text/string property.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampTypeOptionsOrBuilder

getValueTypeOptionsCase()

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

Whether the enumTypeOptions field is set.

hasFloatTypeOptions()

public abstract boolean hasFloatTypeOptions()

Float property.

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

Returns
TypeDescription
boolean

Whether the floatTypeOptions field is set.

hasIntegerTypeOptions()

public abstract boolean hasIntegerTypeOptions()

Integer property.

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

Returns
TypeDescription
boolean

Whether the integerTypeOptions field is set.

hasMapTypeOptions()

public abstract boolean hasMapTypeOptions()

Map property.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the timestampTypeOptions field is set.