Package com.google.cloud.contentwarehouse.v1

Interface PropertyDefinitionOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PropertyDefinition, PropertyDefinition.Builder
    public interface PropertyDefinitionOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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:
        The name.

      • getNameBytes

        com.google.protobuf.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:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         The display-name for the property, used for front-end.
        string display_name = 12;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         The display-name for the property, used for front-end.
        string display_name = 12;
        Returns:
        The bytes for displayName.

      • getIsRepeatable

        boolean getIsRepeatable()
         Whether the property can have multiple values.
        bool is_repeatable = 2;
        Returns:
        The isRepeatable.

      • getIsFilterable

        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:
        The isFilterable.

      • getIsSearchable

        boolean getIsSearchable()
         Indicates that the property should be included in a global search.
        bool is_searchable = 4;
        Returns:
        The isSearchable.

      • getIsMetadata

        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:
        The isMetadata.

      • getIsRequired

        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:
        The isRequired.

      • getRetrievalImportanceValue

        int getRetrievalImportanceValue()
         The retrieval importance of the property during search.
        .google.cloud.contentwarehouse.v1.PropertyDefinition.RetrievalImportance retrieval_importance = 18;
        Returns:
        The enum numeric value on the wire for retrievalImportance.

      • getRetrievalImportance

        PropertyDefinition.RetrievalImportance getRetrievalImportance()
         The retrieval importance of the property during search.
        .google.cloud.contentwarehouse.v1.PropertyDefinition.RetrievalImportance retrieval_importance = 18;
        Returns:
        The retrievalImportance.

      • hasIntegerTypeOptions

        boolean hasIntegerTypeOptions()
         Integer property.
        .google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;
        Returns:
        Whether the integerTypeOptions field is set.

      • getIntegerTypeOptions

        IntegerTypeOptions getIntegerTypeOptions()
         Integer property.
        .google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;
        Returns:
        The integerTypeOptions.

      • getIntegerTypeOptionsOrBuilder

        IntegerTypeOptionsOrBuilder getIntegerTypeOptionsOrBuilder()
         Integer property.
        .google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;

      • hasFloatTypeOptions

        boolean hasFloatTypeOptions()
         Float property.
        .google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;
        Returns:
        Whether the floatTypeOptions field is set.

      • getFloatTypeOptions

        FloatTypeOptions getFloatTypeOptions()
         Float property.
        .google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;
        Returns:
        The floatTypeOptions.

      • getFloatTypeOptionsOrBuilder

        FloatTypeOptionsOrBuilder getFloatTypeOptionsOrBuilder()
         Float property.
        .google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;

      • hasTextTypeOptions

        boolean hasTextTypeOptions()
         Text/string property.
        .google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;
        Returns:
        Whether the textTypeOptions field is set.

      • getTextTypeOptions

        TextTypeOptions getTextTypeOptions()
         Text/string property.
        .google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;
        Returns:
        The textTypeOptions.

      • getTextTypeOptionsOrBuilder

        TextTypeOptionsOrBuilder getTextTypeOptionsOrBuilder()
         Text/string property.
        .google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;

      • hasPropertyTypeOptions

        boolean hasPropertyTypeOptions()
         Nested structured data property.
        .google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;
        Returns:
        Whether the propertyTypeOptions field is set.

      • getPropertyTypeOptions

        PropertyTypeOptions getPropertyTypeOptions()
         Nested structured data property.
        .google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;
        Returns:
        The propertyTypeOptions.

      • getPropertyTypeOptionsOrBuilder

        PropertyTypeOptionsOrBuilder getPropertyTypeOptionsOrBuilder()
         Nested structured data property.
        .google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;

      • hasEnumTypeOptions

        boolean hasEnumTypeOptions()
         Enum/categorical property.
        .google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;
        Returns:
        Whether the enumTypeOptions field is set.

      • getEnumTypeOptions

        EnumTypeOptions getEnumTypeOptions()
         Enum/categorical property.
        .google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;
        Returns:
        The enumTypeOptions.

      • getEnumTypeOptionsOrBuilder

        EnumTypeOptionsOrBuilder getEnumTypeOptionsOrBuilder()
         Enum/categorical property.
        .google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;

      • hasDateTimeTypeOptions

        boolean hasDateTimeTypeOptions()
         Date time property.
 It is not supported by CMEK compliant deployment.
        .google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;
        Returns:
        Whether the dateTimeTypeOptions field is set.

      • getDateTimeTypeOptions

        DateTimeTypeOptions getDateTimeTypeOptions()
         Date time property.
 It is not supported by CMEK compliant deployment.
        .google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;
        Returns:
        The dateTimeTypeOptions.

      • getDateTimeTypeOptionsOrBuilder

        DateTimeTypeOptionsOrBuilder getDateTimeTypeOptionsOrBuilder()
         Date time property.
 It is not supported by CMEK compliant deployment.
        .google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;

      • hasMapTypeOptions

        boolean hasMapTypeOptions()
         Map property.
        .google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;
        Returns:
        Whether the mapTypeOptions field is set.

      • getMapTypeOptions

        MapTypeOptions getMapTypeOptions()
         Map property.
        .google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;
        Returns:
        The mapTypeOptions.

      • getMapTypeOptionsOrBuilder

        MapTypeOptionsOrBuilder getMapTypeOptionsOrBuilder()
         Map property.
        .google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;

      • hasTimestampTypeOptions

        boolean hasTimestampTypeOptions()
         Timestamp property.
 It is not supported by CMEK compliant deployment.
        .google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;
        Returns:
        Whether the timestampTypeOptions field is set.

      • getTimestampTypeOptions

        TimestampTypeOptions getTimestampTypeOptions()
         Timestamp property.
 It is not supported by CMEK compliant deployment.
        .google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;
        Returns:
        The timestampTypeOptions.

      • getTimestampTypeOptionsOrBuilder

        TimestampTypeOptionsOrBuilder getTimestampTypeOptionsOrBuilder()
         Timestamp property.
 It is not supported by CMEK compliant deployment.
        .google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;

      • getSchemaSourcesList

        List<PropertyDefinition.SchemaSource> getSchemaSourcesList()
         The mapping information between this property to another schema source.
        repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

      • getSchemaSources

        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;

      • getSchemaSourcesCount

        int getSchemaSourcesCount()
         The mapping information between this property to another schema source.
        repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;

      • getSchemaSourcesOrBuilderList

        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;

      • getSchemaSourcesOrBuilder

        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;