public static final class HistogramQueryPropertyNameFilter.Builder extends GeneratedMessageV3.Builder<HistogramQueryPropertyNameFilter.Builder> implements HistogramQueryPropertyNameFilterOrBuilderProtobuf type google.cloud.contentwarehouse.v1.HistogramQueryPropertyNameFilter
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > HistogramQueryPropertyNameFilter.BuilderImplements
HistogramQueryPropertyNameFilterOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDocumentSchemas(Iterable<String> values)
public HistogramQueryPropertyNameFilter.Builder addAllDocumentSchemas(Iterable<String> values)This filter specifies the exact document schema(s) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The documentSchemas to add. |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
addAllPropertyNames(Iterable<String> values)
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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The propertyNames to add. |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
addDocumentSchemas(String value)
public HistogramQueryPropertyNameFilter.Builder addDocumentSchemas(String value)This filter specifies the exact document schema(s) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe documentSchemas to add. |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
addDocumentSchemasBytes(ByteString value)
public HistogramQueryPropertyNameFilter.Builder addDocumentSchemasBytes(ByteString value)This filter specifies the exact document schema(s) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the documentSchemas to add. |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
addPropertyNames(String value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe propertyNames to add. |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
addPropertyNamesBytes(ByteString value)
public HistogramQueryPropertyNameFilter.Builder addPropertyNamesBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the propertyNames to add. |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public HistogramQueryPropertyNameFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
build()
public HistogramQueryPropertyNameFilter build()| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter |
|
buildPartial()
public HistogramQueryPropertyNameFilter buildPartial()| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter |
|
clear()
public HistogramQueryPropertyNameFilter.Builder clear()| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
clearDocumentSchemas()
public HistogramQueryPropertyNameFilter.Builder clearDocumentSchemas()This filter specifies the exact document schema(s) 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 | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public HistogramQueryPropertyNameFilter.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public HistogramQueryPropertyNameFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
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 | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
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 | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
clone()
public HistogramQueryPropertyNameFilter.Builder clone()| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
getDefaultInstanceForType()
public HistogramQueryPropertyNameFilter getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDocumentSchemas(int index)
public String getDocumentSchemas(int index)This filter specifies the exact document schema(s) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The documentSchemas at the given index. |
getDocumentSchemasBytes(int index)
public ByteString getDocumentSchemasBytes(int index)This filter specifies the exact document schema(s) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the documentSchemas at the given index. |
getDocumentSchemasCount()
public int getDocumentSchemasCount()This filter specifies the exact document schema(s) 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 | |
|---|---|
| Type | Description |
int |
The count of documentSchemas. |
getDocumentSchemasList()
public ProtocolStringList getDocumentSchemasList()This filter specifies the exact document schema(s) 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 | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the documentSchemas. |
getPropertyNames(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The propertyNames at the given index. |
getPropertyNamesBytes(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the propertyNames at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of propertyNames. |
getPropertyNamesList()
public 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the propertyNames. |
getYAxis()
public 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 | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.HistogramYAxis |
The yAxis. |
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;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for yAxis. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(HistogramQueryPropertyNameFilter other)
public HistogramQueryPropertyNameFilter.Builder mergeFrom(HistogramQueryPropertyNameFilter other)| Parameter | |
|---|---|
| Name | Description |
other |
HistogramQueryPropertyNameFilter |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public HistogramQueryPropertyNameFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public HistogramQueryPropertyNameFilter.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final HistogramQueryPropertyNameFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
setDocumentSchemas(int index, String value)
public HistogramQueryPropertyNameFilter.Builder setDocumentSchemas(int index, String value)This filter specifies the exact document schema(s) 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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe documentSchemas to set. |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public HistogramQueryPropertyNameFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
setPropertyNames(int index, String value)
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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe propertyNames to set. |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public HistogramQueryPropertyNameFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final HistogramQueryPropertyNameFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
|
setYAxis(HistogramQueryPropertyNameFilter.HistogramYAxis value)
public HistogramQueryPropertyNameFilter.Builder setYAxis(HistogramQueryPropertyNameFilter.HistogramYAxis 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;
| Parameter | |
|---|---|
| Name | Description |
value |
HistogramQueryPropertyNameFilter.HistogramYAxisThe yAxis to set. |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |
setYAxisValue(int value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for yAxis to set. |
| Returns | |
|---|---|
| Type | Description |
HistogramQueryPropertyNameFilter.Builder |
This builder for chaining. |