Package com.google.cloud.contentwarehouse.v1

Class PropertyDefinition

  • All Implemented Interfaces:
    PropertyDefinitionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class PropertyDefinition
extends com.google.protobuf.GeneratedMessageV3
implements PropertyDefinitionOrBuilder
     Defines the metadata for a schema property.
    Protobuf type google.cloud.contentwarehouse.v1.PropertyDefinition
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IS_REPEATABLE_FIELD_NUMBER

        public static final int IS_REPEATABLE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IS_FILTERABLE_FIELD_NUMBER

        public static final int IS_FILTERABLE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IS_SEARCHABLE_FIELD_NUMBER

        public static final int IS_SEARCHABLE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IS_METADATA_FIELD_NUMBER

        public static final int IS_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IS_REQUIRED_FIELD_NUMBER

        public static final int IS_REQUIRED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RETRIEVAL_IMPORTANCE_FIELD_NUMBER

        public static final int RETRIEVAL_IMPORTANCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INTEGER_TYPE_OPTIONS_FIELD_NUMBER

        public static final int INTEGER_TYPE_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FLOAT_TYPE_OPTIONS_FIELD_NUMBER

        public static final int FLOAT_TYPE_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_TYPE_OPTIONS_FIELD_NUMBER

        public static final int TEXT_TYPE_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROPERTY_TYPE_OPTIONS_FIELD_NUMBER

        public static final int PROPERTY_TYPE_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENUM_TYPE_OPTIONS_FIELD_NUMBER

        public static final int ENUM_TYPE_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DATE_TIME_TYPE_OPTIONS_FIELD_NUMBER

        public static final int DATE_TIME_TYPE_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAP_TYPE_OPTIONS_FIELD_NUMBER

        public static final int MAP_TYPE_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TIMESTAMP_TYPE_OPTIONS_FIELD_NUMBER

        public static final int TIMESTAMP_TYPE_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCHEMA_SOURCES_FIELD_NUMBER

        public static final int SCHEMA_SOURCES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getName in interface PropertyDefinitionOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface PropertyDefinitionOrBuilder
        Returns:
        The bytes for name.

      • getDisplayNameBytes

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

      • getIsRepeatable

        public boolean getIsRepeatable()
         Whether the property can have multiple values.
        bool is_repeatable = 2;
        Specified by:
        getIsRepeatable in interface PropertyDefinitionOrBuilder
        Returns:
        The isRepeatable.

      • 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;
        Specified by:
        getIsFilterable in interface PropertyDefinitionOrBuilder
        Returns:
        The isFilterable.

      • getIsSearchable

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

      • 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;
        Specified by:
        getIsMetadata in interface PropertyDefinitionOrBuilder
        Returns:
        The isMetadata.

      • 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;
        Specified by:
        getIsRequired in interface PropertyDefinitionOrBuilder
        Returns:
        The isRequired.

      • getRetrievalImportanceValue

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

      • hasIntegerTypeOptions

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

      • hasFloatTypeOptions

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

      • hasTextTypeOptions

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

      • hasPropertyTypeOptions

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

      • hasEnumTypeOptions

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

      • 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;
        Specified by:
        hasDateTimeTypeOptions in interface PropertyDefinitionOrBuilder
        Returns:
        Whether the dateTimeTypeOptions field is set.

      • 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;
        Specified by:
        getDateTimeTypeOptions in interface PropertyDefinitionOrBuilder
        Returns:
        The dateTimeTypeOptions.

      • hasMapTypeOptions

        public boolean hasMapTypeOptions()
         Map property.
        .google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;
        Specified by:
        hasMapTypeOptions in interface PropertyDefinitionOrBuilder
        Returns:
        Whether the mapTypeOptions 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;
        Specified by:
        hasTimestampTypeOptions in interface PropertyDefinitionOrBuilder
        Returns:
        Whether the timestampTypeOptions field is set.

      • getTimestampTypeOptions

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

      • getSchemaSourcesCount

        public int getSchemaSourcesCount()
         The mapping information between this property to another schema source.
        repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;
        Specified by:
        getSchemaSourcesCount in interface PropertyDefinitionOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static PropertyDefinition parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PropertyDefinition parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PropertyDefinition parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PropertyDefinition parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PropertyDefinition parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PropertyDefinition parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PropertyDefinition parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

        public PropertyDefinition.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public PropertyDefinition.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected PropertyDefinition.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<PropertyDefinition> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public PropertyDefinition getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder