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.



1262
1263
1264
# File 'lib/google/apis/docs_v1/classes.rb', line 1262

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



1151
1152
1153
# File 'lib/google/apis/docs_v1/classes.rb', line 1151

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)


1156
1157
1158
# File 'lib/google/apis/docs_v1/classes.rb', line 1156

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)


1162
1163
1164
# File 'lib/google/apis/docs_v1/classes.rb', line 1162

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)


1168
1169
1170
# File 'lib/google/apis/docs_v1/classes.rb', line 1168

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)


1174
1175
1176
# File 'lib/google/apis/docs_v1/classes.rb', line 1174

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)


1180
1181
1182
# File 'lib/google/apis/docs_v1/classes.rb', line 1180

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)


1186
1187
1188
# File 'lib/google/apis/docs_v1/classes.rb', line 1186

def first_page_header_id_suggested
  @first_page_header_id_suggested
end

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


1192
1193
1194
# File 'lib/google/apis/docs_v1/classes.rb', line 1192

def flip_page_orientation_suggested
  @flip_page_orientation_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)


1198
1199
1200
# File 'lib/google/apis/docs_v1/classes.rb', line 1198

def margin_bottom_suggested
  @margin_bottom_suggested
end

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

Returns:

  • (Boolean)


1204
1205
1206
# File 'lib/google/apis/docs_v1/classes.rb', line 1204

def margin_footer_suggested
  @margin_footer_suggested
end

#margin_header_suggestedBoolean Also known as: margin_header_suggested?

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

Returns:

  • (Boolean)


1210
1211
1212
# File 'lib/google/apis/docs_v1/classes.rb', line 1210

def margin_header_suggested
  @margin_header_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)


1216
1217
1218
# File 'lib/google/apis/docs_v1/classes.rb', line 1216

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)


1222
1223
1224
# File 'lib/google/apis/docs_v1/classes.rb', line 1222

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)


1228
1229
1230
# File 'lib/google/apis/docs_v1/classes.rb', line 1228

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)


1234
1235
1236
# File 'lib/google/apis/docs_v1/classes.rb', line 1234

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



1242
1243
1244
# File 'lib/google/apis/docs_v1/classes.rb', line 1242

def page_size_suggestion_state
  @page_size_suggestion_state
end

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

Returns:

  • (Boolean)


1247
1248
1249
# File 'lib/google/apis/docs_v1/classes.rb', line 1247

def use_custom_header_footer_margins_suggested
  @use_custom_header_footer_margins_suggested
end

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

Returns:

  • (Boolean)


1253
1254
1255
# File 'lib/google/apis/docs_v1/classes.rb', line 1253

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)


1259
1260
1261
# File 'lib/google/apis/docs_v1/classes.rb', line 1259

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



1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
# File 'lib/google/apis/docs_v1/classes.rb', line 1267

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