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.



1367
1368
1369
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1367

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:



1256
1257
1258
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1256

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) 


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

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) 


1267
1268
1269
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1267

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) 


1273
1274
1275
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1273

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) 


1279
1280
1281
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1279

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) 


1285
1286
1287
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1285

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) 


1291
1292
1293
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1291

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) 


1297
1298
1299
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1297

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) 


1303
1304
1305
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1303

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) 


1309
1310
1311
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1309

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) 


1315
1316
1317
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1315

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) 


1321
1322
1323
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1321

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) 


1327
1328
1329
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1327

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) 


1333
1334
1335
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1333

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) 


1339
1340
1341
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1339

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:



1347
1348
1349
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1347

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) 


1352
1353
1354
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1352

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) 


1358
1359
1360
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1358

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) 


1364
1365
1366
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1364

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



1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1372

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