Class: Google::Apis::ServicenetworkingV1beta::Page

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Page

Returns a new instance of Page.

[View source]

3117
3118
3119
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3117

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

Instance Attribute Details

#content ⇒ String

The Markdown content of the page. You can use (== include path ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. Corresponds to the JSON property content

Returns:

  • (String) 

3098
3099
3100
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3098

def content
  @content
end

#name ⇒ String

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) 

3109
3110
3111
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3109

def name
  @name
end

#subpages ⇒ Array<Google::Apis::ServicenetworkingV1beta::Page>

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

Returns:


3115
3116
3117
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3115

def subpages
  @subpages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

3122
3123
3124
3125
3126
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3122

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