Package com.google.cloud.retail.v2alpha

Interface GetBranchRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GetBranchRequest, GetBranchRequest.Builder
@Generated public interface GetBranchRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    BranchView
    getView()
    The view to apply to the returned [Branch][google.cloud.retail.v2alpha.Branch].
    int
    getViewValue()
    The view to apply to the returned [Branch][google.cloud.retail.v2alpha.Branch].

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       Required. The name of the branch to retrieve.
 Format:
 `projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id`.

 "default_branch" can be used as a special branch_id, it returns the
 default branch that has been set for the catalog.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The name of the branch to retrieve.
 Format:
 `projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id`.

 "default_branch" can be used as a special branch_id, it returns the
 default branch that has been set for the catalog.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getViewValue

      int getViewValue()
       The view to apply to the returned
 [Branch][google.cloud.retail.v2alpha.Branch]. Defaults to
 [Branch.BranchView.BASIC] if unspecified.
 See documentation of fields of [Branch][google.cloud.retail.v2alpha.Branch]
 to find what fields are excluded from BASIC view.
      .google.cloud.retail.v2alpha.BranchView view = 2;
      Returns:
      The enum numeric value on the wire for view.

    • getView

      BranchView getView()
       The view to apply to the returned
 [Branch][google.cloud.retail.v2alpha.Branch]. Defaults to
 [Branch.BranchView.BASIC] if unspecified.
 See documentation of fields of [Branch][google.cloud.retail.v2alpha.Branch]
 to find what fields are excluded from BASIC view.
      .google.cloud.retail.v2alpha.BranchView view = 2;
      Returns:
      The view.