Package com.google.cloud.retail.v2alpha

Interface SetDefaultBranchRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SetDefaultBranchRequest, SetDefaultBranchRequest.Builder
    public interface SetDefaultBranchRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getBranchId()
      The final component of the resource name of a branch.
      com.google.protobuf.ByteString getBranchIdBytes()
      The final component of the resource name of a branch.
      String getCatalog()
      Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
      com.google.protobuf.ByteString getCatalogBytes()
      Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
      boolean getForce()
      If set to true, it permits switching to a branch with [branch_id][google.cloud.retail.v2alpha.SetDefaultBranchRequest.branch_id] even if it has no sufficient active products.
      String getNote()
      Some note on this request, this can be retrieved by [CatalogService.GetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.GetDefaultBranch] before next valid default branch set occurs.
      com.google.protobuf.ByteString getNoteBytes()
      Some note on this request, this can be retrieved by [CatalogService.GetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.GetDefaultBranch] before next valid default branch set occurs.

      • 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 Detail

      • getCatalog

        String getCatalog()
         Full resource name of the catalog, such as
 `projects/*/locations/global/catalogs/default_catalog`.
        string catalog = 1 [(.google.api.resource_reference) = { ... }
        Returns:
        The catalog.

      • getCatalogBytes

        com.google.protobuf.ByteString getCatalogBytes()
         Full resource name of the catalog, such as
 `projects/*/locations/global/catalogs/default_catalog`.
        string catalog = 1 [(.google.api.resource_reference) = { ... }
        Returns:
        The bytes for catalog.

      • getBranchId

        String getBranchId()
         The final component of the resource name of a branch.

 This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
 error is returned.

 If there are no sufficient active products in the targeted branch and
 [force][google.cloud.retail.v2alpha.SetDefaultBranchRequest.force] is not
 set, a FAILED_PRECONDITION error is returned.
        string branch_id = 2 [(.google.api.resource_reference) = { ... }
        Returns:
        The branchId.

      • getBranchIdBytes

        com.google.protobuf.ByteString getBranchIdBytes()
         The final component of the resource name of a branch.

 This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
 error is returned.

 If there are no sufficient active products in the targeted branch and
 [force][google.cloud.retail.v2alpha.SetDefaultBranchRequest.force] is not
 set, a FAILED_PRECONDITION error is returned.
        string branch_id = 2 [(.google.api.resource_reference) = { ... }
        Returns:
        The bytes for branchId.

      • getNote

        String getNote()
         Some note on this request, this can be retrieved by
 [CatalogService.GetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.GetDefaultBranch]
 before next valid default branch set occurs.

 This field must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string note = 3;
        Returns:
        The note.

      • getNoteBytes

        com.google.protobuf.ByteString getNoteBytes()
         Some note on this request, this can be retrieved by
 [CatalogService.GetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.GetDefaultBranch]
 before next valid default branch set occurs.

 This field must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string note = 3;
        Returns:
        The bytes for note.

      • getForce

        boolean getForce()
         If set to true, it permits switching to a branch with
 [branch_id][google.cloud.retail.v2alpha.SetDefaultBranchRequest.branch_id]
 even if it has no sufficient active products.
        bool force = 4;
        Returns:
        The force.