com.google.api.PageOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/api/documentation.proto

// Protobuf Java Version: 3.25.3
package com.google.api;

public interface PageOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.api.Page)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * 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:
   * <pre><code>pages:
   * - name: Tutorial
   *   content: &#40;== include tutorial.md ==&#41;
   *   subpages:
   *   - name: Java
   *     content: &#40;== include tutorial_java.md ==&#41;
   * </code></pre>
   * You can reference `Java` page using Markdown reference link syntax:
   * `[Java][Tutorial.Java]`.
   * 
   *
   * string name = 1;
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * 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:
   * <pre><code>pages:
   * - name: Tutorial
   *   content: &#40;== include tutorial.md ==&#41;
   *   subpages:
   *   - name: Java
   *     content: &#40;== include tutorial_java.md ==&#41;
   * </code></pre>
   * You can reference `Java` page using Markdown reference link syntax:
   * `[Java][Tutorial.Java]`.
   * 
   *
   * string name = 1;
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * The Markdown content of the page. You can use <code>&#40;== include {path}
   * ==&#41;</code> to include content from a Markdown file. The content can be
   * used to produce the documentation page such as HTML format page.
   * 
   *
   * string content = 2;
   *
   * @return The content.
   */
  java.lang.String getContent();
  /**
   *
   *
   *    * The Markdown content of the page. You can use <code>&#40;== include {path}
   * ==&#41;</code> to include content from a Markdown file. The content can be
   * used to produce the documentation page such as HTML format page.
   * 
   *
   * string content = 2;
   *
   * @return The bytes for content.
   */
  com.google.protobuf.ByteString getContentBytes();

  /**
   *
   *
   *    * Subpages of this page. The order of subpages specified here will be
   * honored in the generated docset.
   * 
   *
   * repeated .google.api.Page subpages = 3;
   */
  java.util.List getSubpagesList();
  /**
   *
   *
   *    * Subpages of this page. The order of subpages specified here will be
   * honored in the generated docset.
   * 
   *
   * repeated .google.api.Page subpages = 3;
   */
  com.google.api.Page getSubpages(int index);
  /**
   *
   *
   *    * Subpages of this page. The order of subpages specified here will be
   * honored in the generated docset.
   * 
   *
   * repeated .google.api.Page subpages = 3;
   */
  int getSubpagesCount();
  /**
   *
   *
   *    * Subpages of this page. The order of subpages specified here will be
   * honored in the generated docset.
   * 
   *
   * repeated .google.api.Page subpages = 3;
   */
  java.util.List getSubpagesOrBuilderList();
  /**
   *
   *
   *    * Subpages of this page. The order of subpages specified here will be
   * honored in the generated docset.
   * 
   *
   * repeated .google.api.Page subpages = 3;
   */
  com.google.api.PageOrBuilder getSubpagesOrBuilder(int index);
}