/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/contentwarehouse/v1/document_schema.proto
package com.google.cloud.contentwarehouse.v1;
public interface PropertyDefinitionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.contentwarehouse.v1.PropertyDefinition)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The display-name for the property, used for front-end.
*
*
* string display_name = 12;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* The display-name for the property, used for front-end.
*
*
* string display_name = 12;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Whether the property can have multiple values.
*
*
* bool is_repeatable = 2;
*
* @return The isRepeatable.
*/
boolean getIsRepeatable();
/**
*
*
*
* Whether the property can be filtered. If this is a sub-property, all the
* parent properties must be marked filterable.
*
*
* bool is_filterable = 3;
*
* @return The isFilterable.
*/
boolean getIsFilterable();
/**
*
*
*
* Indicates that the property should be included in a global search.
*
*
* bool is_searchable = 4;
*
* @return The isSearchable.
*/
boolean getIsSearchable();
/**
*
*
*
* 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;
*
* @return The isMetadata.
*/
boolean getIsMetadata();
/**
*
*
*
* 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;
*
* @return The isRequired.
*/
boolean getIsRequired();
/**
*
*
*
* The retrieval importance of the property during search.
*
*
*
* .google.cloud.contentwarehouse.v1.PropertyDefinition.RetrievalImportance retrieval_importance = 18;
*
*
* @return The enum numeric value on the wire for retrievalImportance.
*/
int getRetrievalImportanceValue();
/**
*
*
*
* The retrieval importance of the property during search.
*
*
*
* .google.cloud.contentwarehouse.v1.PropertyDefinition.RetrievalImportance retrieval_importance = 18;
*
*
* @return The retrievalImportance.
*/
com.google.cloud.contentwarehouse.v1.PropertyDefinition.RetrievalImportance
getRetrievalImportance();
/**
*
*
*
* Integer property.
*
*
* .google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;
*
* @return Whether the integerTypeOptions field is set.
*/
boolean hasIntegerTypeOptions();
/**
*
*
*
* Integer property.
*
*
* .google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;
*
* @return The integerTypeOptions.
*/
com.google.cloud.contentwarehouse.v1.IntegerTypeOptions getIntegerTypeOptions();
/**
*
*
*
* Integer property.
*
*
* .google.cloud.contentwarehouse.v1.IntegerTypeOptions integer_type_options = 7;
*/
com.google.cloud.contentwarehouse.v1.IntegerTypeOptionsOrBuilder getIntegerTypeOptionsOrBuilder();
/**
*
*
*
* Float property.
*
*
* .google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;
*
* @return Whether the floatTypeOptions field is set.
*/
boolean hasFloatTypeOptions();
/**
*
*
*
* Float property.
*
*
* .google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;
*
* @return The floatTypeOptions.
*/
com.google.cloud.contentwarehouse.v1.FloatTypeOptions getFloatTypeOptions();
/**
*
*
*
* Float property.
*
*
* .google.cloud.contentwarehouse.v1.FloatTypeOptions float_type_options = 8;
*/
com.google.cloud.contentwarehouse.v1.FloatTypeOptionsOrBuilder getFloatTypeOptionsOrBuilder();
/**
*
*
*
* Text/string property.
*
*
* .google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;
*
* @return Whether the textTypeOptions field is set.
*/
boolean hasTextTypeOptions();
/**
*
*
*
* Text/string property.
*
*
* .google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;
*
* @return The textTypeOptions.
*/
com.google.cloud.contentwarehouse.v1.TextTypeOptions getTextTypeOptions();
/**
*
*
*
* Text/string property.
*
*
* .google.cloud.contentwarehouse.v1.TextTypeOptions text_type_options = 9;
*/
com.google.cloud.contentwarehouse.v1.TextTypeOptionsOrBuilder getTextTypeOptionsOrBuilder();
/**
*
*
*
* Nested structured data property.
*
*
* .google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;
*
* @return Whether the propertyTypeOptions field is set.
*/
boolean hasPropertyTypeOptions();
/**
*
*
*
* Nested structured data property.
*
*
* .google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;
*
* @return The propertyTypeOptions.
*/
com.google.cloud.contentwarehouse.v1.PropertyTypeOptions getPropertyTypeOptions();
/**
*
*
*
* Nested structured data property.
*
*
* .google.cloud.contentwarehouse.v1.PropertyTypeOptions property_type_options = 10;
*/
com.google.cloud.contentwarehouse.v1.PropertyTypeOptionsOrBuilder
getPropertyTypeOptionsOrBuilder();
/**
*
*
*
* Enum/categorical property.
*
*
* .google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;
*
* @return Whether the enumTypeOptions field is set.
*/
boolean hasEnumTypeOptions();
/**
*
*
*
* Enum/categorical property.
*
*
* .google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;
*
* @return The enumTypeOptions.
*/
com.google.cloud.contentwarehouse.v1.EnumTypeOptions getEnumTypeOptions();
/**
*
*
*
* Enum/categorical property.
*
*
* .google.cloud.contentwarehouse.v1.EnumTypeOptions enum_type_options = 11;
*/
com.google.cloud.contentwarehouse.v1.EnumTypeOptionsOrBuilder getEnumTypeOptionsOrBuilder();
/**
*
*
*
* Date time property.
* It is not supported by CMEK compliant deployment.
*
*
* .google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;
*
* @return Whether the dateTimeTypeOptions field is set.
*/
boolean hasDateTimeTypeOptions();
/**
*
*
*
* Date time property.
* It is not supported by CMEK compliant deployment.
*
*
* .google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;
*
* @return The dateTimeTypeOptions.
*/
com.google.cloud.contentwarehouse.v1.DateTimeTypeOptions getDateTimeTypeOptions();
/**
*
*
*
* Date time property.
* It is not supported by CMEK compliant deployment.
*
*
* .google.cloud.contentwarehouse.v1.DateTimeTypeOptions date_time_type_options = 13;
*/
com.google.cloud.contentwarehouse.v1.DateTimeTypeOptionsOrBuilder
getDateTimeTypeOptionsOrBuilder();
/**
*
*
*
* Map property.
*
*
* .google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;
*
* @return Whether the mapTypeOptions field is set.
*/
boolean hasMapTypeOptions();
/**
*
*
*
* Map property.
*
*
* .google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;
*
* @return The mapTypeOptions.
*/
com.google.cloud.contentwarehouse.v1.MapTypeOptions getMapTypeOptions();
/**
*
*
*
* Map property.
*
*
* .google.cloud.contentwarehouse.v1.MapTypeOptions map_type_options = 15;
*/
com.google.cloud.contentwarehouse.v1.MapTypeOptionsOrBuilder getMapTypeOptionsOrBuilder();
/**
*
*
*
* Timestamp property.
* It is not supported by CMEK compliant deployment.
*
*
* .google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;
*
*
* @return Whether the timestampTypeOptions field is set.
*/
boolean hasTimestampTypeOptions();
/**
*
*
*
* Timestamp property.
* It is not supported by CMEK compliant deployment.
*
*
* .google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;
*
*
* @return The timestampTypeOptions.
*/
com.google.cloud.contentwarehouse.v1.TimestampTypeOptions getTimestampTypeOptions();
/**
*
*
*
* Timestamp property.
* It is not supported by CMEK compliant deployment.
*
*
* .google.cloud.contentwarehouse.v1.TimestampTypeOptions timestamp_type_options = 16;
*
*/
com.google.cloud.contentwarehouse.v1.TimestampTypeOptionsOrBuilder
getTimestampTypeOptionsOrBuilder();
/**
*
*
*
* The mapping information between this property to another schema source.
*
*
*
* repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;
*
*/
java.util.List
getSchemaSourcesList();
/**
*
*
*
* The mapping information between this property to another schema source.
*
*
*
* repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;
*
*/
com.google.cloud.contentwarehouse.v1.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;
*
*/
int getSchemaSourcesCount();
/**
*
*
*
* The mapping information between this property to another schema source.
*
*
*
* repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;
*
*/
java.util.List<
? extends com.google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSourceOrBuilder>
getSchemaSourcesOrBuilderList();
/**
*
*
*
* The mapping information between this property to another schema source.
*
*
*
* repeated .google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSource schema_sources = 19;
*
*/
com.google.cloud.contentwarehouse.v1.PropertyDefinition.SchemaSourceOrBuilder
getSchemaSourcesOrBuilder(int index);
public com.google.cloud.contentwarehouse.v1.PropertyDefinition.ValueTypeOptionsCase
getValueTypeOptionsCase();
}