Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetDefaultBranchRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/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) ⇒ GoogleCloudRetailV2alphaSetDefaultBranchRequest

Returns a new instance of GoogleCloudRetailV2alphaSetDefaultBranchRequest.



5729
5730
5731
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5729

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) 


5712
5713
5714
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5712

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) 


5718
5719
5720
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5718

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) 


5727
5728
5729
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5727

def note
  @note
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5734
5735
5736
5737
5738
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5734

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