Class HistogramQueryPropertyNameFilter (0.39.0)

public final class HistogramQueryPropertyNameFilter extends GeneratedMessageV3 implements HistogramQueryPropertyNameFilterOrBuilder

Protobuf type google.cloud.contentwarehouse.v1.HistogramQueryPropertyNameFilter

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HistogramQueryPropertyNameFilter

Static Fields

DOCUMENT_SCHEMAS_FIELD_NUMBER

public static final int DOCUMENT_SCHEMAS_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_NAMES_FIELD_NUMBER

public static final int PROPERTY_NAMES_FIELD_NUMBER
Field Value
Type Description
int

Y_AXIS_FIELD_NUMBER

public static final int Y_AXIS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HistogramQueryPropertyNameFilter getDefaultInstance()
Returns
Type Description
HistogramQueryPropertyNameFilter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HistogramQueryPropertyNameFilter.Builder newBuilder()
Returns
Type Description
HistogramQueryPropertyNameFilter.Builder

newBuilder(HistogramQueryPropertyNameFilter prototype)

public static HistogramQueryPropertyNameFilter.Builder newBuilder(HistogramQueryPropertyNameFilter prototype)
Parameter
Name Description
prototype HistogramQueryPropertyNameFilter
Returns
Type Description
HistogramQueryPropertyNameFilter.Builder

parseDelimitedFrom(InputStream input)

public static HistogramQueryPropertyNameFilter parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryPropertyNameFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HistogramQueryPropertyNameFilter parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryPropertyNameFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HistogramQueryPropertyNameFilter parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryPropertyNameFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HistogramQueryPropertyNameFilter parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryPropertyNameFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HistogramQueryPropertyNameFilter parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryPropertyNameFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HistogramQueryPropertyNameFilter parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HistogramQueryPropertyNameFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistogramQueryPropertyNameFilter
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HistogramQueryPropertyNameFilter> parser()
Returns
Type Description
Parser<HistogramQueryPropertyNameFilter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public HistogramQueryPropertyNameFilter getDefaultInstanceForType()
Returns
Type Description
HistogramQueryPropertyNameFilter

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 int

The 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 int

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

getParserForType()

public Parser<HistogramQueryPropertyNameFilter> getParserForType()
Returns
Type Description
Parser<HistogramQueryPropertyNameFilter>
Overrides

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 int

The 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 int

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HistogramQueryPropertyNameFilter.Builder newBuilderForType()
Returns
Type Description
HistogramQueryPropertyNameFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HistogramQueryPropertyNameFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HistogramQueryPropertyNameFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HistogramQueryPropertyNameFilter.Builder toBuilder()
Returns
Type Description
HistogramQueryPropertyNameFilter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException