public final class HistogramQueryPropertyNameFilter extends GeneratedMessageV3 implements HistogramQueryPropertyNameFilterOrBuilder
Protobuf type google.cloud.contentwarehouse.v1.HistogramQueryPropertyNameFilter
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static HistogramQueryPropertyNameFilter.Builder newBuilder()
newBuilder(HistogramQueryPropertyNameFilter prototype)
public static HistogramQueryPropertyNameFilter.Builder newBuilder(HistogramQueryPropertyNameFilter prototype)
parseDelimitedFrom(InputStream input)
public static HistogramQueryPropertyNameFilter parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static HistogramQueryPropertyNameFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static HistogramQueryPropertyNameFilter parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HistogramQueryPropertyNameFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static HistogramQueryPropertyNameFilter parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HistogramQueryPropertyNameFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static HistogramQueryPropertyNameFilter parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HistogramQueryPropertyNameFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static HistogramQueryPropertyNameFilter parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static HistogramQueryPropertyNameFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static HistogramQueryPropertyNameFilter parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HistogramQueryPropertyNameFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<HistogramQueryPropertyNameFilter> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public HistogramQueryPropertyNameFilter getDefaultInstanceForType()
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) = { ... }
getParserForType()
public Parser<HistogramQueryPropertyNameFilter> getParserForType()
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;
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;
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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public HistogramQueryPropertyNameFilter.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HistogramQueryPropertyNameFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public HistogramQueryPropertyNameFilter.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
