Class: Google::Apis::DocsV1::DocumentStyleSuggestionState

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

Overview

A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DocumentStyleSuggestionState

Returns a new instance of DocumentStyleSuggestionState.



1645
1646
1647
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1645

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

Instance Attribute Details

#background_suggestion_state ⇒ Google::Apis::DocsV1::BackgroundSuggestionState

A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. Corresponds to the JSON property backgroundSuggestionState

Returns:



1534
1535
1536
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1534

def background_suggestion_state
  @background_suggestion_state
end

#default_footer_id_suggested ⇒ Boolean Also known as: default_footer_id_suggested?

Indicates if there was a suggested change to default_footer_id. Corresponds to the JSON property defaultFooterIdSuggested

Returns:

  • (Boolean) 


1539
1540
1541
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1539

def default_footer_id_suggested
  @default_footer_id_suggested
end

#default_header_id_suggested ⇒ Boolean Also known as: default_header_id_suggested?

Indicates if there was a suggested change to default_header_id. Corresponds to the JSON property defaultHeaderIdSuggested

Returns:

  • (Boolean) 


1545
1546
1547
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1545

def default_header_id_suggested
  @default_header_id_suggested
end

#even_page_footer_id_suggested ⇒ Boolean Also known as: even_page_footer_id_suggested?

Indicates if there was a suggested change to even_page_footer_id. Corresponds to the JSON property evenPageFooterIdSuggested

Returns:

  • (Boolean) 


1551
1552
1553
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1551

def even_page_footer_id_suggested
  @even_page_footer_id_suggested
end

#even_page_header_id_suggested ⇒ Boolean Also known as: even_page_header_id_suggested?

Indicates if there was a suggested change to even_page_header_id. Corresponds to the JSON property evenPageHeaderIdSuggested

Returns:

  • (Boolean) 


1557
1558
1559
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1557

def even_page_header_id_suggested
  @even_page_header_id_suggested
end

#first_page_footer_id_suggested ⇒ Boolean Also known as: first_page_footer_id_suggested?

Indicates if there was a suggested change to first_page_footer_id. Corresponds to the JSON property firstPageFooterIdSuggested

Returns:

  • (Boolean) 


1563
1564
1565
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1563

def first_page_footer_id_suggested
  @first_page_footer_id_suggested
end

#first_page_header_id_suggested ⇒ Boolean Also known as: first_page_header_id_suggested?

Indicates if there was a suggested change to first_page_header_id. Corresponds to the JSON property firstPageHeaderIdSuggested

Returns:

  • (Boolean) 


1569
1570
1571
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1569

def first_page_header_id_suggested
  @first_page_header_id_suggested
end

#flip_page_orientation_suggested ⇒ Boolean Also known as: flip_page_orientation_suggested?

Optional. Indicates if there was a suggested change to flip_page_orientation. Corresponds to the JSON property flipPageOrientationSuggested

Returns:

  • (Boolean) 


1575
1576
1577
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1575

def flip_page_orientation_suggested
  @flip_page_orientation_suggested
end

#margin_bottom_suggested ⇒ Boolean Also known as: margin_bottom_suggested?

Indicates if there was a suggested change to margin_bottom. Corresponds to the JSON property marginBottomSuggested

Returns:

  • (Boolean) 


1581
1582
1583
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1581

def margin_bottom_suggested
  @margin_bottom_suggested
end

#margin_footer_suggested ⇒ Boolean Also known as: margin_footer_suggested?

Indicates if there was a suggested change to margin_footer. Corresponds to the JSON property marginFooterSuggested

Returns:

  • (Boolean) 


1587
1588
1589
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1587

def margin_footer_suggested
  @margin_footer_suggested
end

#margin_header_suggested ⇒ Boolean Also known as: margin_header_suggested?

Indicates if there was a suggested change to margin_header. Corresponds to the JSON property marginHeaderSuggested

Returns:

  • (Boolean) 


1593
1594
1595
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1593

def margin_header_suggested
  @margin_header_suggested
end

#margin_left_suggested ⇒ Boolean Also known as: margin_left_suggested?

Indicates if there was a suggested change to margin_left. Corresponds to the JSON property marginLeftSuggested

Returns:

  • (Boolean) 


1599
1600
1601
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1599

def margin_left_suggested
  @margin_left_suggested
end

#margin_right_suggested ⇒ Boolean Also known as: margin_right_suggested?

Indicates if there was a suggested change to margin_right. Corresponds to the JSON property marginRightSuggested

Returns:

  • (Boolean) 


1605
1606
1607
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1605

def margin_right_suggested
  @margin_right_suggested
end

#margin_top_suggested ⇒ Boolean Also known as: margin_top_suggested?

Indicates if there was a suggested change to margin_top. Corresponds to the JSON property marginTopSuggested

Returns:

  • (Boolean) 


1611
1612
1613
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1611

def margin_top_suggested
  @margin_top_suggested
end

#page_number_start_suggested ⇒ Boolean Also known as: page_number_start_suggested?

Indicates if there was a suggested change to page_number_start. Corresponds to the JSON property pageNumberStartSuggested

Returns:

  • (Boolean) 


1617
1618
1619
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1617

def page_number_start_suggested
  @page_number_start_suggested
end

#page_size_suggestion_state ⇒ Google::Apis::DocsV1::SizeSuggestionState

A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. Corresponds to the JSON property pageSizeSuggestionState

Returns:



1625
1626
1627
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1625

def page_size_suggestion_state
  @page_size_suggestion_state
end

#use_custom_header_footer_margins_suggested ⇒ Boolean Also known as: use_custom_header_footer_margins_suggested?

Indicates if there was a suggested change to use_custom_header_footer_margins. Corresponds to the JSON property useCustomHeaderFooterMarginsSuggested

Returns:

  • (Boolean) 


1630
1631
1632
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1630

def use_custom_header_footer_margins_suggested
  @use_custom_header_footer_margins_suggested
end

#use_even_page_header_footer_suggested ⇒ Boolean Also known as: use_even_page_header_footer_suggested?

Indicates if there was a suggested change to use_even_page_header_footer. Corresponds to the JSON property useEvenPageHeaderFooterSuggested

Returns:

  • (Boolean) 


1636
1637
1638
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1636

def use_even_page_header_footer_suggested
  @use_even_page_header_footer_suggested
end

#use_first_page_header_footer_suggested ⇒ Boolean Also known as: use_first_page_header_footer_suggested?

Indicates if there was a suggested change to use_first_page_header_footer. Corresponds to the JSON property useFirstPageHeaderFooterSuggested

Returns:

  • (Boolean) 


1642
1643
1644
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1642

def use_first_page_header_footer_suggested
  @use_first_page_header_footer_suggested
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1650

def update!(**args)
  @background_suggestion_state = args[:background_suggestion_state] if args.key?(:background_suggestion_state)
  @default_footer_id_suggested = args[:default_footer_id_suggested] if args.key?(:default_footer_id_suggested)
  @default_header_id_suggested = args[:default_header_id_suggested] if args.key?(:default_header_id_suggested)
  @even_page_footer_id_suggested = args[:even_page_footer_id_suggested] if args.key?(:even_page_footer_id_suggested)
  @even_page_header_id_suggested = args[:even_page_header_id_suggested] if args.key?(:even_page_header_id_suggested)
  @first_page_footer_id_suggested = args[:first_page_footer_id_suggested] if args.key?(:first_page_footer_id_suggested)
  @first_page_header_id_suggested = args[:first_page_header_id_suggested] if args.key?(:first_page_header_id_suggested)
  @flip_page_orientation_suggested = args[:flip_page_orientation_suggested] if args.key?(:flip_page_orientation_suggested)
  @margin_bottom_suggested = args[:margin_bottom_suggested] if args.key?(:margin_bottom_suggested)
  @margin_footer_suggested = args[:margin_footer_suggested] if args.key?(:margin_footer_suggested)
  @margin_header_suggested = args[:margin_header_suggested] if args.key?(:margin_header_suggested)
  @margin_left_suggested = args[:margin_left_suggested] if args.key?(:margin_left_suggested)
  @margin_right_suggested = args[:margin_right_suggested] if args.key?(:margin_right_suggested)
  @margin_top_suggested = args[:margin_top_suggested] if args.key?(:margin_top_suggested)
  @page_number_start_suggested = args[:page_number_start_suggested] if args.key?(:page_number_start_suggested)
  @page_size_suggestion_state = args[:page_size_suggestion_state] if args.key?(:page_size_suggestion_state)
  @use_custom_header_footer_margins_suggested = args[:use_custom_header_footer_margins_suggested] if args.key?(:use_custom_header_footer_margins_suggested)
  @use_even_page_header_footer_suggested = args[:use_even_page_header_footer_suggested] if args.key?(:use_even_page_header_footer_suggested)
  @use_first_page_header_footer_suggested = args[:use_first_page_header_footer_suggested] if args.key?(:use_first_page_header_footer_suggested)
end