Class: Google::Cloud::Retail::V2::SetDefaultBranchRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/catalog_service.rb

Overview

Request message to set a specified branch as new default_branch.

Instance Attribute Summary collapse

Instance Attribute Details

#branch_id ⇒ ::String

Returns 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 is not set, a FAILED_PRECONDITION error is returned.

Returns:

  • (::String) —

    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 is not set, a FAILED_PRECONDITION error is returned.



129
130
131
132
 
# File 'proto_docs/google/cloud/retail/v2/catalog_service.rb', line 129

class SetDefaultBranchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#catalog ⇒ ::String

Returns Full resource name of the catalog, such as projects/*/locations/global/catalogs/default_catalog.

Returns:

  • (::String) —

    Full resource name of the catalog, such as projects/*/locations/global/catalogs/default_catalog.



129
130
131
132
 
# File 'proto_docs/google/cloud/retail/v2/catalog_service.rb', line 129

class SetDefaultBranchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#force ⇒ ::Boolean

Returns If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.

Returns:

  • (::Boolean) —

    If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.



129
130
131
132
 
# File 'proto_docs/google/cloud/retail/v2/catalog_service.rb', line 129

class SetDefaultBranchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#note ⇒ ::String

Returns Some note on this request, this can be retrieved by 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.

Returns:

  • (::String) —

    Some note on this request, this can be retrieved by 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.



129
130
131
132
 
# File 'proto_docs/google/cloud/retail/v2/catalog_service.rb', line 129

class SetDefaultBranchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end