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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/docs_v1/classes.rb,
generated/google/apis/docs_v1/representations.rb,
generated/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 is a new suggested value.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DocumentStyleSuggestionState

Returns a new instance of DocumentStyleSuggestionState



1142
1143
1144
# File 'generated/google/apis/docs_v1/classes.rb', line 1142

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

Instance Attribute Details

#background_suggestion_stateGoogle::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



1054
1055
1056
# File 'generated/google/apis/docs_v1/classes.rb', line 1054

def background_suggestion_state
  @background_suggestion_state
end

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

Returns:

  • (Boolean)


1059
1060
1061
# File 'generated/google/apis/docs_v1/classes.rb', line 1059

def default_footer_id_suggested
  @default_footer_id_suggested
end

#default_header_id_suggestedBoolean 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)


1065
1066
1067
# File 'generated/google/apis/docs_v1/classes.rb', line 1065

def default_header_id_suggested
  @default_header_id_suggested
end

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

Returns:

  • (Boolean)


1071
1072
1073
# File 'generated/google/apis/docs_v1/classes.rb', line 1071

def even_page_footer_id_suggested
  @even_page_footer_id_suggested
end

#even_page_header_id_suggestedBoolean 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)


1077
1078
1079
# File 'generated/google/apis/docs_v1/classes.rb', line 1077

def even_page_header_id_suggested
  @even_page_header_id_suggested
end

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

Returns:

  • (Boolean)


1083
1084
1085
# File 'generated/google/apis/docs_v1/classes.rb', line 1083

def first_page_footer_id_suggested
  @first_page_footer_id_suggested
end

#first_page_header_id_suggestedBoolean 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)


1089
1090
1091
# File 'generated/google/apis/docs_v1/classes.rb', line 1089

def first_page_header_id_suggested
  @first_page_header_id_suggested
end

#margin_bottom_suggestedBoolean Also known as: margin_bottom_suggested?

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

Returns:

  • (Boolean)


1095
1096
1097
# File 'generated/google/apis/docs_v1/classes.rb', line 1095

def margin_bottom_suggested
  @margin_bottom_suggested
end

#margin_left_suggestedBoolean Also known as: margin_left_suggested?

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

Returns:

  • (Boolean)


1101
1102
1103
# File 'generated/google/apis/docs_v1/classes.rb', line 1101

def margin_left_suggested
  @margin_left_suggested
end

#margin_right_suggestedBoolean Also known as: margin_right_suggested?

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

Returns:

  • (Boolean)


1107
1108
1109
# File 'generated/google/apis/docs_v1/classes.rb', line 1107

def margin_right_suggested
  @margin_right_suggested
end

#margin_top_suggestedBoolean Also known as: margin_top_suggested?

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

Returns:

  • (Boolean)


1113
1114
1115
# File 'generated/google/apis/docs_v1/classes.rb', line 1113

def margin_top_suggested
  @margin_top_suggested
end

#page_number_start_suggestedBoolean 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)


1119
1120
1121
# File 'generated/google/apis/docs_v1/classes.rb', line 1119

def page_number_start_suggested
  @page_number_start_suggested
end

#page_size_suggestion_stateGoogle::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



1128
1129
1130
# File 'generated/google/apis/docs_v1/classes.rb', line 1128

def page_size_suggestion_state
  @page_size_suggestion_state
end

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

Returns:

  • (Boolean)


1133
1134
1135
# File 'generated/google/apis/docs_v1/classes.rb', line 1133

def use_even_page_header_footer_suggested
  @use_even_page_header_footer_suggested
end

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

Returns:

  • (Boolean)


1139
1140
1141
# File 'generated/google/apis/docs_v1/classes.rb', line 1139

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



1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
# File 'generated/google/apis/docs_v1/classes.rb', line 1147

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)
  @margin_bottom_suggested = args[:margin_bottom_suggested] if args.key?(:margin_bottom_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_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