Class PropertyDefinition (0.3.0) 

public final class PropertyDefinition extends GeneratedMessageV3 implements PropertyDefinitionOrBuilder

Defines the metadata for a schema property.

Protobuf type google.cloud.contentwarehouse.v1.PropertyDefinition

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PropertyDefinition

Static Fields

DATE_TIME_TYPE_OPTIONS_FIELD_NUMBER

public static final int DATE_TIME_TYPE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ENUM_TYPE_OPTIONS_FIELD_NUMBER

public static final int ENUM_TYPE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

FLOAT_TYPE_OPTIONS_FIELD_NUMBER

public static final int FLOAT_TYPE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

INTEGER_TYPE_OPTIONS_FIELD_NUMBER

public static final int INTEGER_TYPE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

IS_FILTERABLE_FIELD_NUMBER

public static final int IS_FILTERABLE_FIELD_NUMBER
Field Value
Type Description
int

IS_METADATA_FIELD_NUMBER

public static final int IS_METADATA_FIELD_NUMBER
Field Value
Type Description
int

IS_REPEATABLE_FIELD_NUMBER

public static final int IS_REPEATABLE_FIELD_NUMBER
Field Value
Type Description
int

IS_REQUIRED_FIELD_NUMBER

public static final int IS_REQUIRED_FIELD_NUMBER
Field Value
Type Description
int

IS_SEARCHABLE_FIELD_NUMBER

public static final int IS_SEARCHABLE_FIELD_NUMBER
Field Value
Type Description
int

MAP_TYPE_OPTIONS_FIELD_NUMBER

public static final int MAP_TYPE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_TYPE_OPTIONS_FIELD_NUMBER

public static final int PROPERTY_TYPE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

TEXT_TYPE_OPTIONS_FIELD_NUMBER

public static final int TEXT_TYPE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

TIMESTAMP_TYPE_OPTIONS_FIELD_NUMBER

public static final int TIMESTAMP_TYPE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PropertyDefinition getDefaultInstance()
Returns
Type Description
PropertyDefinition

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PropertyDefinition.Builder newBuilder()
Returns
Type Description
PropertyDefinition.Builder

newBuilder(PropertyDefinition prototype)

public static PropertyDefinition.Builder newBuilder(PropertyDefinition prototype)
Parameter
Name Description
prototype PropertyDefinition
Returns
Type Description
PropertyDefinition.Builder

parseDelimitedFrom(InputStream input)

public static PropertyDefinition parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PropertyDefinition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PropertyDefinition parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PropertyDefinition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PropertyDefinition parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PropertyDefinition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PropertyDefinition parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PropertyDefinition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PropertyDefinition parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PropertyDefinition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PropertyDefinition parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PropertyDefinition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyDefinition
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PropertyDefinition> parser()
Returns
Type Description
Parser<PropertyDefinition>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
DateTimeTypeOptions

The dateTimeTypeOptions.

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
Type Description
DateTimeTypeOptionsOrBuilder

getDefaultInstanceForType()

public PropertyDefinition getDefaultInstanceForType()
Returns
Type Description
PropertyDefinition

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
Type Description
EnumTypeOptions

The enumTypeOptions.

getEnumTypeOptionsOrBuilder()

public EnumTypeOptionsOrBuilder getEnumTypeOptionsOrBuilder()

Enum/categorical property.

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

Returns
Type Description
EnumTypeOptionsOrBuilder

getFloatTypeOptions()

public FloatTypeOptions getFloatTypeOptions()

Float property.

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

Returns
Type Description
FloatTypeOptions

The floatTypeOptions.

getFloatTypeOptionsOrBuilder()

public FloatTypeOptionsOrBuilder getFloatTypeOptionsOrBuilder()

Float property.

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

Returns
Type Description
FloatTypeOptionsOrBuilder

getIntegerTypeOptions()

public IntegerTypeOptions getIntegerTypeOptions()

Integer property.

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

Returns
Type Description
IntegerTypeOptions

The integerTypeOptions.

getIntegerTypeOptionsOrBuilder()

public IntegerTypeOptionsOrBuilder getIntegerTypeOptionsOrBuilder()

Integer property.

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

Returns
Type Description
IntegerTypeOptionsOrBuilder

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
Type Description
MapTypeOptions

The mapTypeOptions.

getMapTypeOptionsOrBuilder()

public MapTypeOptionsOrBuilder getMapTypeOptionsOrBuilder()

Map property.

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

Returns
Type Description
MapTypeOptionsOrBuilder

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];

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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<PropertyDefinition> getParserForType()
Returns
Type Description
Parser<PropertyDefinition>
Overrides

getPropertyTypeOptions()

public PropertyTypeOptions getPropertyTypeOptions()

Nested structured data property.

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

Returns
Type Description
PropertyTypeOptions

The propertyTypeOptions.

getPropertyTypeOptionsOrBuilder()

public PropertyTypeOptionsOrBuilder getPropertyTypeOptionsOrBuilder()

Nested structured data property.

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

Returns
Type Description
PropertyTypeOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTextTypeOptions()

public TextTypeOptions getTextTypeOptions()

Text/string property.

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

Returns
Type Description
TextTypeOptions

The textTypeOptions.

getTextTypeOptionsOrBuilder()

public TextTypeOptionsOrBuilder getTextTypeOptionsOrBuilder()

Text/string property.

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

Returns
Type Description
TextTypeOptionsOrBuilder

getTimestampTypeOptions()

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getValueTypeOptionsCase()

public PropertyDefinition.ValueTypeOptionsCase getValueTypeOptionsCase()
Returns
Type Description
PropertyDefinition.ValueTypeOptionsCase

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PropertyDefinition.Builder newBuilderForType()
Returns
Type Description
PropertyDefinition.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PropertyDefinition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PropertyDefinition.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PropertyDefinition.Builder toBuilder()
Returns
Type Description
PropertyDefinition.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException