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.



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

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



1196
1197
1198
# File 'generated/google/apis/docs_v1/classes.rb', line 1196

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)


1201
1202
1203
# File 'generated/google/apis/docs_v1/classes.rb', line 1201

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)


1207
1208
1209
# File 'generated/google/apis/docs_v1/classes.rb', line 1207

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)


1213
1214
1215
# File 'generated/google/apis/docs_v1/classes.rb', line 1213

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)


1219
1220
1221
# File 'generated/google/apis/docs_v1/classes.rb', line 1219

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)


1225
1226
1227
# File 'generated/google/apis/docs_v1/classes.rb', line 1225

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)


1231
1232
1233
# File 'generated/google/apis/docs_v1/classes.rb', line 1231

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)


1237
1238
1239
# File 'generated/google/apis/docs_v1/classes.rb', line 1237

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)


1243
1244
1245
# File 'generated/google/apis/docs_v1/classes.rb', line 1243

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)


1249
1250
1251
# File 'generated/google/apis/docs_v1/classes.rb', line 1249

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)


1255
1256
1257
# File 'generated/google/apis/docs_v1/classes.rb', line 1255

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)


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

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)


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

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)


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

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



1282
1283
1284
# File 'generated/google/apis/docs_v1/classes.rb', line 1282

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)


1288
1289
1290
# File 'generated/google/apis/docs_v1/classes.rb', line 1288

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)


1294
1295
1296
# File 'generated/google/apis/docs_v1/classes.rb', line 1294

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)


1300
1301
1302
# File 'generated/google/apis/docs_v1/classes.rb', line 1300

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



1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
# File 'generated/google/apis/docs_v1/classes.rb', line 1308

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_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