public final class PropertyDefinition extends GeneratedMessageV3 implements PropertyDefinitionOrBuilder
Defines the metadata for a schema property.
Protobuf type google.cloud.contentwarehouse.v1.PropertyDefinition
Static Fields
DATE_TIME_TYPE_OPTIONS_FIELD_NUMBER
public static final int DATE_TIME_TYPE_OPTIONS_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ENUM_TYPE_OPTIONS_FIELD_NUMBER
public static final int ENUM_TYPE_OPTIONS_FIELD_NUMBER
Field Value
FLOAT_TYPE_OPTIONS_FIELD_NUMBER
public static final int FLOAT_TYPE_OPTIONS_FIELD_NUMBER
Field Value
INTEGER_TYPE_OPTIONS_FIELD_NUMBER
public static final int INTEGER_TYPE_OPTIONS_FIELD_NUMBER
Field Value
IS_FILTERABLE_FIELD_NUMBER
public static final int IS_FILTERABLE_FIELD_NUMBER
Field Value
IS_METADATA_FIELD_NUMBER
public static final int IS_METADATA_FIELD_NUMBER
Field Value
IS_REPEATABLE_FIELD_NUMBER
public static final int IS_REPEATABLE_FIELD_NUMBER
Field Value
IS_REQUIRED_FIELD_NUMBER
public static final int IS_REQUIRED_FIELD_NUMBER
Field Value
IS_SEARCHABLE_FIELD_NUMBER
public static final int IS_SEARCHABLE_FIELD_NUMBER
Field Value
MAP_TYPE_OPTIONS_FIELD_NUMBER
public static final int MAP_TYPE_OPTIONS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PROPERTY_TYPE_OPTIONS_FIELD_NUMBER
public static final int PROPERTY_TYPE_OPTIONS_FIELD_NUMBER
Field Value
TEXT_TYPE_OPTIONS_FIELD_NUMBER
public static final int TEXT_TYPE_OPTIONS_FIELD_NUMBER
Field Value
TIMESTAMP_TYPE_OPTIONS_FIELD_NUMBER
public static final int TIMESTAMP_TYPE_OPTIONS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PropertyDefinition getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PropertyDefinition.Builder newBuilder()
Returns
newBuilder(PropertyDefinition prototype)
public static PropertyDefinition.Builder newBuilder(PropertyDefinition prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static PropertyDefinition parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyDefinition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PropertyDefinition parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PropertyDefinition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PropertyDefinition parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PropertyDefinition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static PropertyDefinition parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyDefinition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static PropertyDefinition parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyDefinition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PropertyDefinition parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PropertyDefinition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PropertyDefinition> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
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
getDefaultInstanceForType()
public PropertyDefinition getDefaultInstanceForType()
Returns
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
getEnumTypeOptionsOrBuilder()
public EnumTypeOptionsOrBuilder getEnumTypeOptionsOrBuilder()
Enum/categorical property.
.google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;
Returns
getFloatTypeOptions()
public FloatTypeOptions getFloatTypeOptions()
Float property.
.google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;
Returns
getFloatTypeOptionsOrBuilder()
public FloatTypeOptionsOrBuilder getFloatTypeOptionsOrBuilder()
Float property.
.google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;
Returns
getIntegerTypeOptions()
public IntegerTypeOptions getIntegerTypeOptions()
Integer property.
.google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;
Returns
getIntegerTypeOptionsOrBuilder()
public IntegerTypeOptionsOrBuilder getIntegerTypeOptionsOrBuilder()
Integer property.
.google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;
Returns
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.
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
getMapTypeOptionsOrBuilder()
public MapTypeOptionsOrBuilder getMapTypeOptionsOrBuilder()
Map property.
.google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;
Returns
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
getParserForType()
public Parser<PropertyDefinition> getParserForType()
Returns
Overrides
getPropertyTypeOptions()
public PropertyTypeOptions getPropertyTypeOptions()
Nested structured data property.
.google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;
Returns
getPropertyTypeOptionsOrBuilder()
public PropertyTypeOptionsOrBuilder getPropertyTypeOptionsOrBuilder()
Nested structured data property.
.google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTextTypeOptions()
public TextTypeOptions getTextTypeOptions()
Text/string property.
.google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;
Returns
getTextTypeOptionsOrBuilder()
public TextTypeOptionsOrBuilder getTextTypeOptionsOrBuilder()
Text/string property.
.google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;
Returns
getTimestampTypeOptions()
public TimestampTypeOptions getTimestampTypeOptions()
Timestamp property.
It is not supported by CMEK compliant deployment.
.google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;
Returns
getTimestampTypeOptionsOrBuilder()
public TimestampTypeOptionsOrBuilder getTimestampTypeOptionsOrBuilder()
Timestamp property.
It is not supported by CMEK compliant deployment.
.google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getValueTypeOptionsCase()
public PropertyDefinition.ValueTypeOptionsCase getValueTypeOptionsCase()
Returns
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PropertyDefinition.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PropertyDefinition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PropertyDefinition.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions