Class: Google::Apis::RetailV2::GoogleCloudRetailV2SetDefaultBranchRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

Request message to set a specified branch as new default_branch.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2SetDefaultBranchRequest

Returns a new instance of GoogleCloudRetailV2SetDefaultBranchRequest.



5545
5546
5547
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5545

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#branch_id ⇒ 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. Corresponds to the JSON property branchId

Returns:

  • (String) 


5528
5529
5530
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5528

def branch_id
  @branch_id
end

#force ⇒ Boolean Also known as: force?

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

Returns:

  • (Boolean) 


5534
5535
5536
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5534

def force
  @force
end

#note ⇒ 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. Corresponds to the JSON property note

Returns:

  • (String) 


5543
5544
5545
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5543

def note
  @note
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5550
5551
5552
5553
5554
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5550

def update!(**args)
  @branch_id = args[:branch_id] if args.key?(:branch_id)
  @force = args[:force] if args.key?(:force)
  @note = args[:note] if args.key?(:note)
end