Class Branch (2.55.0)

public final class Branch extends GeneratedMessageV3 implements BranchOrBuilder

A data branch that stores all instances of Products.

Protobuf type google.cloud.retail.v2alpha.Branch

Inheritance

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

Implements

BranchOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

IS_DEFAULT_FIELD_NUMBER

public static final int IS_DEFAULT_FIELD_NUMBER

Field Value
Type	Description
`int`

LAST_PRODUCT_IMPORT_TIME_FIELD_NUMBER

public static final int LAST_PRODUCT_IMPORT_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

PRODUCT_COUNT_STATS_FIELD_NUMBER

public static final int PRODUCT_COUNT_STATS_FIELD_NUMBER

Field Value
Type	Description
`int`

QUALITY_METRICS_FIELD_NUMBER

public static final int QUALITY_METRICS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Branch getDefaultInstance()

Returns
Type	Description
`Branch`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Branch.Builder newBuilder()

Returns
Type	Description
`Branch.Builder`

newBuilder(Branch prototype)

public static Branch.Builder newBuilder(Branch prototype)

Parameter
Name	Description
`prototype`	`Branch`

Returns
Type	Description
`Branch.Builder`

parseDelimitedFrom(InputStream input)

public static Branch parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Branch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Branch parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Branch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Branch parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Branch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Branch parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Branch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Branch parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Branch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Branch parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Branch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Branch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Branch> parser()

Returns
Type	Description
`Parser<Branch>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Branch getDefaultInstanceForType()

Returns
Type	Description
`Branch`

getDisplayName()

public String getDisplayName()

Output only. Human readable name of the branch to display in the UI.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. Human readable name of the branch to display in the UI.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for displayName.

getIsDefault()

public boolean getIsDefault()

Output only. Indicates whether this branch is set as the default branch of its parent catalog.

bool is_default = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	The isDefault.

getLastProductImportTime()

public Timestamp getLastProductImportTime()

Output only. Timestamp of last import through ProductService.ImportProducts. Empty value means no import has been made to this branch.

.google.protobuf.Timestamp last_product_import_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The lastProductImportTime.

getLastProductImportTimeOrBuilder()

public TimestampOrBuilder getLastProductImportTimeOrBuilder()

Output only. Timestamp of last import through ProductService.ImportProducts. Empty value means no import has been made to this branch.

.google.protobuf.Timestamp last_product_import_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getName()

public String getName()

Immutable. Full resource name of the branch, such as projects/*/locations/global/catalogs/default_catalog/branches/branch_id.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. Full resource name of the branch, such as projects/*/locations/global/catalogs/default_catalog/branches/branch_id.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`ByteString`	The bytes for name.

getParserForType()

public Parser<Branch> getParserForType()

Returns
Type	Description
`Parser<Branch>`

Overrides

GeneratedMessageV3.getParserForType()

getProductCountStats(int index)

public Branch.ProductCountStatistic getProductCountStats(int index)

Output only. Statistics for number of products in the branch, provided for different scopes.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.ProductCountStatistic product_count_stats = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Branch.ProductCountStatistic`

getProductCountStatsCount()

public int getProductCountStatsCount()

Output only. Statistics for number of products in the branch, provided for different scopes.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.ProductCountStatistic product_count_stats = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

getProductCountStatsList()

public List<Branch.ProductCountStatistic> getProductCountStatsList()

Output only. Statistics for number of products in the branch, provided for different scopes.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.ProductCountStatistic product_count_stats = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<ProductCountStatistic>`

getProductCountStatsOrBuilder(int index)

public Branch.ProductCountStatisticOrBuilder getProductCountStatsOrBuilder(int index)

Output only. Statistics for number of products in the branch, provided for different scopes.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.ProductCountStatistic product_count_stats = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Branch.ProductCountStatisticOrBuilder`

getProductCountStatsOrBuilderList()

public List<? extends Branch.ProductCountStatisticOrBuilder> getProductCountStatsOrBuilderList()

Output only. Statistics for number of products in the branch, provided for different scopes.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.ProductCountStatistic product_count_stats = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<? extends com.google.cloud.retail.v2alpha.Branch.ProductCountStatisticOrBuilder>`

getQualityMetrics(int index)

public Branch.QualityMetric getQualityMetrics(int index)

Output only. The quality metrics measured among products of this branch.

See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.QualityMetric quality_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Branch.QualityMetric`

getQualityMetricsCount()

public int getQualityMetricsCount()

Output only. The quality metrics measured among products of this branch.

See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.QualityMetric quality_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

getQualityMetricsList()

public List<Branch.QualityMetric> getQualityMetricsList()

Output only. The quality metrics measured among products of this branch.

See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.QualityMetric quality_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<QualityMetric>`

getQualityMetricsOrBuilder(int index)

public Branch.QualityMetricOrBuilder getQualityMetricsOrBuilder(int index)

Output only. The quality metrics measured among products of this branch.

See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.QualityMetric quality_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Branch.QualityMetricOrBuilder`

getQualityMetricsOrBuilderList()

public List<? extends Branch.QualityMetricOrBuilder> getQualityMetricsOrBuilderList()

Output only. The quality metrics measured among products of this branch.

See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.QualityMetric quality_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<? extends com.google.cloud.retail.v2alpha.Branch.QualityMetricOrBuilder>`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

hasLastProductImportTime()

public boolean hasLastProductImportTime()

Output only. Timestamp of last import through ProductService.ImportProducts. Empty value means no import has been made to this branch.

.google.protobuf.Timestamp last_product_import_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the lastProductImportTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Branch.Builder newBuilderForType()

Returns
Type	Description
`Branch.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Branch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Branch.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Branch.Builder toBuilder()

Returns
Type	Description
`Branch.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`