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.


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

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


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

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)

1148
1149
1150
# File 'generated/google/apis/docs_v1/classes.rb', line 1148

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)

1154
1155
1156
# File 'generated/google/apis/docs_v1/classes.rb', line 1154

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)

1160
1161
1162
# File 'generated/google/apis/docs_v1/classes.rb', line 1160

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)

1166
1167
1168
# File 'generated/google/apis/docs_v1/classes.rb', line 1166

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)

1172
1173
1174
# File 'generated/google/apis/docs_v1/classes.rb', line 1172

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)

1178
1179
1180
# File 'generated/google/apis/docs_v1/classes.rb', line 1178

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)

1184
1185
1186
# File 'generated/google/apis/docs_v1/classes.rb', line 1184

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)

1190
1191
1192
# File 'generated/google/apis/docs_v1/classes.rb', line 1190

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)

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

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)

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

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)

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

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)

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

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)

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

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


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

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)

1233
1234
1235
# File 'generated/google/apis/docs_v1/classes.rb', line 1233

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)

1239
1240
1241
# File 'generated/google/apis/docs_v1/classes.rb', line 1239

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)

1245
1246
1247
# File 'generated/google/apis/docs_v1/classes.rb', line 1245

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


1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
# File 'generated/google/apis/docs_v1/classes.rb', line 1253

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