Package com.google.cloud.contentwarehouse.v1

Interface HistogramQueryPropertyNameFilterOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      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.
      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.
      List<String> 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.
      String getPropertyNames​(int index)
      It is optional.
      com.google.protobuf.ByteString getPropertyNamesBytes​(int index)
      It is optional.
      int getPropertyNamesCount()
      It is optional.
      List<String> getPropertyNamesList()
      It is optional.
      HistogramQueryPropertyNameFilter.HistogramYAxis getYAxis()
      By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is not set.
      int getYAxisValue()
      By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is not set.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getDocumentSchemasList

        List<String> 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) = { ... }
        Returns:
        A list containing the documentSchemas.

      • getDocumentSchemasCount

        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) = { ... }
        Returns:
        The count of documentSchemas.

      • getDocumentSchemas

        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) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The documentSchemas at the given index.

      • getDocumentSchemasBytes

        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) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the documentSchemas at the given index.

      • getPropertyNamesList

        List<String> 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;
        Returns:
        A list containing the propertyNames.

      • getPropertyNamesCount

        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;
        Returns:
        The count of propertyNames.

      • getPropertyNames

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The propertyNames at the given index.

      • getPropertyNamesBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the propertyNames at the given index.

      • getYAxisValue

        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;
        Returns:
        The enum numeric value on the wire for yAxis.

      • getYAxis

        HistogramQueryPropertyNameFilter.HistogramYAxis getYAxis()
         By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is not
 set.
        .google.cloud.contentwarehouse.v1.HistogramQueryPropertyNameFilter.HistogramYAxis y_axis = 3;
        Returns:
        The yAxis.