Package com.google.cloud.contentwarehouse.v1

Class HistogramQueryPropertyNameFilter.Builder

    • Method Detail

      • 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.Builder<HistogramQueryPropertyNameFilter.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQueryPropertyNameFilter.Builder>

      • getDefaultInstanceForType

        public HistogramQueryPropertyNameFilter getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<HistogramQueryPropertyNameFilter.Builder>

      • 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.

      • setDocumentSchemas

        public HistogramQueryPropertyNameFilter.Builder setDocumentSchemas​(int index,
                                                                   String value)
         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 to set the value at.
        value - The documentSchemas to set.
        Returns:
        This builder for chaining.

      • addDocumentSchemas

        public HistogramQueryPropertyNameFilter.Builder addDocumentSchemas​(String value)
         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:
        value - The documentSchemas to add.
        Returns:
        This builder for chaining.

      • addAllDocumentSchemas

        public HistogramQueryPropertyNameFilter.Builder addAllDocumentSchemas​(Iterable<String> values)
         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:
        values - The documentSchemas to add.
        Returns:
        This builder for chaining.

      • clearDocumentSchemas

        public HistogramQueryPropertyNameFilter.Builder clearDocumentSchemas()
         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:
        This builder for chaining.

      • addDocumentSchemasBytes

        public HistogramQueryPropertyNameFilter.Builder addDocumentSchemasBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the documentSchemas to add.
        Returns:
        This builder for chaining.

      • 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.

      • setPropertyNames

        public HistogramQueryPropertyNameFilter.Builder setPropertyNames​(int index,
                                                                 String value)
         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 to set the value at.
        value - The propertyNames to set.
        Returns:
        This builder for chaining.

      • addPropertyNames

        public HistogramQueryPropertyNameFilter.Builder addPropertyNames​(String value)
         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:
        value - The propertyNames to add.
        Returns:
        This builder for chaining.

      • addAllPropertyNames

        public HistogramQueryPropertyNameFilter.Builder addAllPropertyNames​(Iterable<String> values)
         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:
        values - The propertyNames to add.
        Returns:
        This builder for chaining.

      • clearPropertyNames

        public HistogramQueryPropertyNameFilter.Builder clearPropertyNames()
         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:
        This builder for chaining.

      • addPropertyNamesBytes

        public HistogramQueryPropertyNameFilter.Builder addPropertyNamesBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the propertyNames to add.
        Returns:
        This builder for chaining.

      • 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.

      • setYAxisValue

        public HistogramQueryPropertyNameFilter.Builder setYAxisValue​(int value)
         By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is not
 set.
        .google.cloud.contentwarehouse.v1.HistogramQueryPropertyNameFilter.HistogramYAxis y_axis = 3;
        Parameters:
        value - The enum numeric value on the wire for yAxis to set.
        Returns:
        This builder for chaining.

      • clearYAxis

        public HistogramQueryPropertyNameFilter.Builder clearYAxis()
         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:
        This builder for chaining.