Package com.google.cloud.contentwarehouse.v1

Class HistogramQueryPropertyNameFilter

    • Field Detail

      • DOCUMENT_SCHEMAS_FIELD_NUMBER

        public static final int DOCUMENT_SCHEMAS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROPERTY_NAMES_FIELD_NUMBER

        public static final int PROPERTY_NAMES_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

      • getDocumentSchemasList

        public com.google.protobuf.ProtocolStringList getDocumentSchemasList()
         This filter specifies the exact document schema(s)
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name]
 to run histogram query against. It is optional. It will perform histogram
 for property names for all the document schemas if it is not set.

 At most 10 document schema names are allowed.
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        repeated string document_schemas = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDocumentSchemasList in interface HistogramQueryPropertyNameFilterOrBuilder
        Returns:
        A list containing the documentSchemas.

      • getDocumentSchemasCount

        public int getDocumentSchemasCount()
         This filter specifies the exact document schema(s)
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name]
 to run histogram query against. It is optional. It will perform histogram
 for property names for all the document schemas if it is not set.

 At most 10 document schema names are allowed.
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        repeated string document_schemas = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDocumentSchemasCount in interface HistogramQueryPropertyNameFilterOrBuilder
        Returns:
        The count of documentSchemas.

      • getDocumentSchemas

        public String getDocumentSchemas​(int index)
         This filter specifies the exact document schema(s)
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name]
 to run histogram query against. It is optional. It will perform histogram
 for property names for all the document schemas if it is not set.

 At most 10 document schema names are allowed.
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        repeated string document_schemas = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDocumentSchemas in interface HistogramQueryPropertyNameFilterOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The documentSchemas at the given index.

      • getDocumentSchemasBytes

        public com.google.protobuf.ByteString getDocumentSchemasBytes​(int index)
         This filter specifies the exact document schema(s)
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name]
 to run histogram query against. It is optional. It will perform histogram
 for property names for all the document schemas if it is not set.

 At most 10 document schema names are allowed.
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        repeated string document_schemas = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDocumentSchemasBytes in interface HistogramQueryPropertyNameFilterOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the documentSchemas at the given index.

      • getPropertyNamesList

        public com.google.protobuf.ProtocolStringList getPropertyNamesList()
         It is optional. It will perform histogram for all the property names if it
 is not set.
 The properties need to be defined with the is_filterable flag set to
 true and the name of the property should be in the format:
 "schemaId.propertyName". The property needs to be defined in the schema.
 Example: the schema id is abc. Then the name of property for property
 MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE".
        repeated string property_names = 2;
        Specified by:
        getPropertyNamesList in interface HistogramQueryPropertyNameFilterOrBuilder
        Returns:
        A list containing the propertyNames.

      • getPropertyNamesCount

        public int getPropertyNamesCount()
         It is optional. It will perform histogram for all the property names if it
 is not set.
 The properties need to be defined with the is_filterable flag set to
 true and the name of the property should be in the format:
 "schemaId.propertyName". The property needs to be defined in the schema.
 Example: the schema id is abc. Then the name of property for property
 MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE".
        repeated string property_names = 2;
        Specified by:
        getPropertyNamesCount in interface HistogramQueryPropertyNameFilterOrBuilder
        Returns:
        The count of propertyNames.

      • getPropertyNames

        public String getPropertyNames​(int index)
         It is optional. It will perform histogram for all the property names if it
 is not set.
 The properties need to be defined with the is_filterable flag set to
 true and the name of the property should be in the format:
 "schemaId.propertyName". The property needs to be defined in the schema.
 Example: the schema id is abc. Then the name of property for property
 MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE".
        repeated string property_names = 2;
        Specified by:
        getPropertyNames in interface HistogramQueryPropertyNameFilterOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The propertyNames at the given index.

      • getPropertyNamesBytes

        public com.google.protobuf.ByteString getPropertyNamesBytes​(int index)
         It is optional. It will perform histogram for all the property names if it
 is not set.
 The properties need to be defined with the is_filterable flag set to
 true and the name of the property should be in the format:
 "schemaId.propertyName". The property needs to be defined in the schema.
 Example: the schema id is abc. Then the name of property for property
 MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE".
        repeated string property_names = 2;
        Specified by:
        getPropertyNamesBytes in interface HistogramQueryPropertyNameFilterOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the propertyNames at the given index.

      • getYAxisValue

        public int getYAxisValue()
         By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is not
 set.
        .google.cloud.contentwarehouse.v1.HistogramQueryPropertyNameFilter.HistogramYAxis y_axis = 3;
        Specified by:
        getYAxisValue in interface HistogramQueryPropertyNameFilterOrBuilder
        Returns:
        The enum numeric value on the wire for yAxis.

      • 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 HistogramQueryPropertyNameFilter parseFrom​(ByteBuffer data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<HistogramQueryPropertyNameFilter> 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 HistogramQueryPropertyNameFilter getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder