Class: Google::Apis::DocsV1::CreateHeaderRequest

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

Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specificed, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned.

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) ⇒ CreateHeaderRequest

Returns a new instance of CreateHeaderRequest.


455
456
457
# File 'generated/google/apis/docs_v1/classes.rb', line 455

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

Instance Attribute Details

#section_break_locationGoogle::Apis::DocsV1::Location

A particular location in the document. Corresponds to the JSON property sectionBreakLocation


448
449
450
# File 'generated/google/apis/docs_v1/classes.rb', line 448

def section_break_location
  @section_break_location
end

#typeString

The type of header to create. Corresponds to the JSON property type

Returns:

  • (String)

453
454
455
# File 'generated/google/apis/docs_v1/classes.rb', line 453

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


460
461
462
463
# File 'generated/google/apis/docs_v1/classes.rb', line 460

def update!(**args)
  @section_break_location = args[:section_break_location] if args.key?(:section_break_location)
  @type = args[:type] if args.key?(:type)
end