Interface HistogramQueryPropertyNameFilterOrBuilder (0.5.0)

Version 0.5.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface HistogramQueryPropertyNameFilterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDocumentSchemas(int index)

public abstract 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	int The index of the element to return.

Returns

Type	Description
String	The documentSchemas at the given index.

getDocumentSchemasBytes(int index)

public abstract 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	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the documentSchemas at the given index.

getDocumentSchemasCount()

public abstract 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 abstract List<String> 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
List<String>	A list containing the documentSchemas.

getPropertyNames(int index)

public abstract 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	int The index of the element to return.

Returns

Type	Description
String	The propertyNames at the given index.

getPropertyNamesBytes(int index)

public abstract 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	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the propertyNames at the given index.

getPropertyNamesCount()

public abstract 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 abstract 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

Type	Description
List<String>	A list containing the propertyNames.

getYAxis()

public abstract 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 abstract 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.