Class: Google::Apis::ServicenetworkingV1::Page

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/servicenetworking_v1/classes.rb,
generated/google/apis/servicenetworking_v1/representations.rb,
generated/google/apis/servicenetworking_v1/representations.rb

Overview

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

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

Returns a new instance of Page.


2641
2642
2643
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 2641

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

Instance Attribute Details

#contentString

The Markdown content of the page. You can use (== include path ==) to include content from a Markdown file. Corresponds to the JSON property content

Returns:

  • (String)

2622
2623
2624
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 2622

def content
  @content
end

#nameString

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example: pages:

  • name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference Java page using Markdown reference link syntax: Java. Corresponds to the JSON property name

Returns:

  • (String)

2633
2634
2635
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 2633

def name
  @name
end

#subpagesArray<Google::Apis::ServicenetworkingV1::Page>

Subpages of this page. The order of subpages specified here will be honored in the generated docset. Corresponds to the JSON property subpages


2639
2640
2641
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 2639

def subpages
  @subpages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2646
2647
2648
2649
2650
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 2646

def update!(**args)
  @content = args[:content] if args.key?(:content)
  @name = args[:name] if args.key?(:name)
  @subpages = args[:subpages] if args.key?(:subpages)
end