Package com.google.cloud.retail.v2alpha

Class Branch

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.Branch
All Implemented Interfaces:
BranchOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Branch extends com.google.protobuf.GeneratedMessage implements BranchOrBuilder
 A data branch that stores all instances of
 [Product][google.cloud.retail.v2alpha.Product]s.
Protobuf type google.cloud.retail.v2alpha.Branch
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • IS_DEFAULT_FIELD_NUMBER

      public static final int IS_DEFAULT_FIELD_NUMBER
      See Also:

    • LAST_PRODUCT_IMPORT_TIME_FIELD_NUMBER

      public static final int LAST_PRODUCT_IMPORT_TIME_FIELD_NUMBER
      See Also:

    • PRODUCT_COUNT_STATS_FIELD_NUMBER

      public static final int PRODUCT_COUNT_STATS_FIELD_NUMBER
      See Also:

    • QUALITY_METRICS_FIELD_NUMBER

      public static final int QUALITY_METRICS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getName in interface BranchOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface BranchOrBuilder
      Returns:
      The bytes for name.

    • 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];
      Specified by:
      getDisplayName in interface BranchOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.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];
      Specified by:
      getDisplayNameBytes in interface BranchOrBuilder
      Returns:
      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];
      Specified by:
      getIsDefault in interface BranchOrBuilder
      Returns:
      The isDefault.

    • hasLastProductImportTime

      public boolean hasLastProductImportTime()
       Output only. Timestamp of last import through
 [ProductService.ImportProducts][google.cloud.retail.v2alpha.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];
      Specified by:
      hasLastProductImportTime in interface BranchOrBuilder
      Returns:
      Whether the lastProductImportTime field is set.

    • getLastProductImportTime

      public com.google.protobuf.Timestamp getLastProductImportTime()
       Output only. Timestamp of last import through
 [ProductService.ImportProducts][google.cloud.retail.v2alpha.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];
      Specified by:
      getLastProductImportTime in interface BranchOrBuilder
      Returns:
      The lastProductImportTime.

    • getLastProductImportTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getLastProductImportTimeOrBuilder()
       Output only. Timestamp of last import through
 [ProductService.ImportProducts][google.cloud.retail.v2alpha.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];
      Specified by:
      getLastProductImportTimeOrBuilder in interface BranchOrBuilder

    • getProductCountStatsList

      public List<Branch.ProductCountStatistic> getProductCountStatsList()
       Output only. Statistics for number of products in the branch, provided for
 different
 [scopes][google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope].

 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];
      Specified by:
      getProductCountStatsList in interface BranchOrBuilder

    • getProductCountStatsOrBuilderList

      public List<? extends Branch.ProductCountStatisticOrBuilder> getProductCountStatsOrBuilderList()
       Output only. Statistics for number of products in the branch, provided for
 different
 [scopes][google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope].

 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];
      Specified by:
      getProductCountStatsOrBuilderList in interface BranchOrBuilder

    • getProductCountStatsCount

      public int getProductCountStatsCount()
       Output only. Statistics for number of products in the branch, provided for
 different
 [scopes][google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope].

 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];
      Specified by:
      getProductCountStatsCount in interface BranchOrBuilder

    • getProductCountStats

      public Branch.ProductCountStatistic getProductCountStats(int index)
       Output only. Statistics for number of products in the branch, provided for
 different
 [scopes][google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope].

 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];
      Specified by:
      getProductCountStats in interface BranchOrBuilder

    • getProductCountStatsOrBuilder

      public Branch.ProductCountStatisticOrBuilder getProductCountStatsOrBuilder(int index)
       Output only. Statistics for number of products in the branch, provided for
 different
 [scopes][google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope].

 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];
      Specified by:
      getProductCountStatsOrBuilder in interface BranchOrBuilder

    • getQualityMetricsList

      public List<Branch.QualityMetric> getQualityMetricsList()
       Output only. The quality metrics measured among products of this branch.

 See
 [QualityMetric.requirement_key][google.cloud.retail.v2alpha.Branch.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];
      Specified by:
      getQualityMetricsList in interface BranchOrBuilder

    • getQualityMetricsOrBuilderList

      public List<? extends Branch.QualityMetricOrBuilder> getQualityMetricsOrBuilderList()
       Output only. The quality metrics measured among products of this branch.

 See
 [QualityMetric.requirement_key][google.cloud.retail.v2alpha.Branch.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];
      Specified by:
      getQualityMetricsOrBuilderList in interface BranchOrBuilder

    • getQualityMetricsCount

      public int getQualityMetricsCount()
       Output only. The quality metrics measured among products of this branch.

 See
 [QualityMetric.requirement_key][google.cloud.retail.v2alpha.Branch.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];
      Specified by:
      getQualityMetricsCount in interface BranchOrBuilder

    • getQualityMetrics

      public Branch.QualityMetric getQualityMetrics(int index)
       Output only. The quality metrics measured among products of this branch.

 See
 [QualityMetric.requirement_key][google.cloud.retail.v2alpha.Branch.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];
      Specified by:
      getQualityMetrics in interface BranchOrBuilder

    • getQualityMetricsOrBuilder

      public Branch.QualityMetricOrBuilder getQualityMetricsOrBuilder(int index)
       Output only. The quality metrics measured among products of this branch.

 See
 [QualityMetric.requirement_key][google.cloud.retail.v2alpha.Branch.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];
      Specified by:
      getQualityMetricsOrBuilder in interface BranchOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Branch parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Branch parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Branch parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Branch parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Branch parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Branch parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Branch parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Branch parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Branch parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Branch parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Branch parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Branch parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Branch.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Branch.Builder newBuilder()

    • newBuilder

      public static Branch.Builder newBuilder(Branch prototype)

    • toBuilder

      public Branch.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Branch.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Branch getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Branch> parser()

    • getParserForType

      public com.google.protobuf.Parser<Branch> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Branch getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder